List organization Scan Policies

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

List the scan policies for this organization.

Requires read:policy 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.

2 available options

namedisplayName

sortDirstring

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

2 available options

ascdesc

pagestring

Pagination page key.

Response

List of organization scan policy basic information.

application/json

hasNext

boolean

has a next page of results.

hasPrev

boolean

has a previous page of results.

pagination.Page

Hide child attributesShow child attributes

nextPage.filters

pagination.Filter[]

Generic filters that each type can define for its needs (isConnected=true, hasMapping=false, etc)

Hide child attributesShow child attributes

nextPage.filters.multi

pagination.MultiValue

Hide child attributesShow child attributes

nextPage.filters.multi.values

string[]

The values of a given filter to filter on.

nextPage.filters.name

string

The name of the filter to apply.

nextPage.filters.value

string

A single value to filter on.

nextPage.number

integer<int32>

The page number to retrieve - 0 based

nextPage.query

string

The query string to filter the results.

nextPage.size

integer<int32>

the page size to retrieve.

nextPage.sortOptions

pagination.SortOptions

Hide child attributesShow child attributes

nextPage.sortOptions.direction

enum<string>

The direction to sort the results.

3 available options

ASCDESCUNSORTED

nextPage.sortOptions.field

string

Generic here, each type should define its own Enums + Converters

nextPageToken

string

PageToken to provide for the next page of results.

policies

scanpolicy.OrganizationScanPolicyInfo[]

The list of scan polices

Hide child attributesShow child attributes

policies.description

string

The description for this policy.

policies.displayName

string

The human readable display name for this policy.

policies.name

string

The referencable unique name of a organizations scan policy.

policies.organizationId

string

The organizationId the scan policy belongs to.

pagination.Page

Hide child attributesShow child attributes

prevPage.filters

pagination.Filter[]

Generic filters that each type can define for its needs (isConnected=true, hasMapping=false, etc)

Hide child attributesShow child attributes

prevPage.filters.multi

pagination.MultiValue

Hide child attributesShow child attributes

prevPage.filters.multi.values

string[]

The values of a given filter to filter on.

prevPage.filters.name

string

The name of the filter to apply.

prevPage.filters.value

string

A single value to filter on.

prevPage.number

integer<int32>

The page number to retrieve - 0 based

prevPage.query

string

The query string to filter the results.

prevPage.size

integer<int32>

the page size to retrieve.

prevPage.sortOptions

pagination.SortOptions

Hide child attributesShow child attributes

prevPage.sortOptions.direction

enum<string>

The direction to sort the results.

3 available options

ASCDESCUNSORTED

prevPage.sortOptions.field

string

Generic here, each type should define its own Enums + Converters

prevPageToken

string

PageToken to provide for the previous page of results.

totalCount

integer<int64>

Total number of results.

Unauthorized

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

cURL

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

Copy

List organization Scan Policies

Path parameters

Query parameters

Response

Your privacy settings