List Organization Scan Configurat… | StackHawk Documentation

List Organization Scan Configuration

GET /api/v1/configuration/{orgId}/list

List the HawkScan configurations for this organization.

Requires read:scan_config permission.

Path parameters

orgIdstring · uuidrequired

UUID identifier for this StackHawk Organization.

Query parameters

pageSizeinteger · int32

Pagination response size limit.

default: 10

pageTokeninteger · int32

Pagination request page increment.

default: 0

sortFieldstring

Resource field to sort paginated response by.

1 available option

name

sortDirstring

Paginated results are sorted 'asc' or 'desc'.

2 available options

ascdesc

pagestring

Pagination page key.

querystring

Name of a Scan Configuration.

Response

List of organization scan configurations.

application/json

configs

configuration.OrganizationScanConfigurationInfo[]

The list of organization scan configurations.

Hide child attributesShow child attributes

configs.description

string

The description for this scan configuration.

configs.name

string

The referencable unique name for this organization scan configuration.

configs.organizationId

string

The organizationId the scan configuration belongs to.

hasNext

boolean

Has a next page of results.

hasPrev

boolean

Has a previous page of results.

nextPageToken

string

PageToken to provide for the next page of results.

prevPageToken

string

PageToken to provide for the previous page of results.

totalCount

integer<int64>

Total number of results.

Unauthorized

GET /api/v1/configuration/{orgId}/list

cURL

curl --request GET \
  --url 'https://api.stackhawk.com/api/v1/configuration/{orgId}/list' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Copy

List Organization Scan Configuration

Path parameters

Query parameters

Response

Your privacy settings