STstackhawk
Applications

List Environments

List Environments

First time here? - use our V2 environments API instead!

Lists environments that belong to this application.

Returns a paginated list of Environments.

ParameterDefaultDescription
environments[]List of environments.
nextPageToken""PageToken to provide for the next page of results.
totalCount0Total number of results.

Environment

An Application-environment with details of recent scan stats included.

ParameterDefaultDescription
environmentName""The name of this environment.
environmentId""The UUID identifier of this environment.
currentScanSummary{}Summary of the scan results and triaged findings for this environment.
latestScanType"UNKNOWN"Type of newest scan in this environment. Options include DEFAULT, REST, GRAPHQL, GRPC, SOAP.

Scan Summary

The summary of findings from scan results.

ParameterDefaultDescription
configHash""Hash of the HawkScan configuration used for this scan.
timestamp0Seconds since unix epoch timestamp of when the scan was started.
alertStats{}Summarized statistics of findings for this scan.
version""The version of HawkScan used for this scan.
scanId""The UUID identifier of this scan.
applicationId""The UUID identifier of this scan's application.

The returned list of environments is filtered by the User's API Token Team membership.

Requires read:application permission.

get/api/v1/app/{appId}/env/list

Request

  • Base URL
    https://api.stackhawk.com
  • URL
    https://api.stackhawk.com/api/v1/app/{appId}/env/list
  • Auth
    HTTP bearer

Path parameters

appIdstring uuid required

UUID identifier for this StackHawk Application.

Query parameters

envsstring[]

A comma-delimited list of environment names of StackHawk Applications to filter by.

pageSizeinteger

Pagination response size limit.

pageTokeninteger

Pagination request page increment.

sortField'id' | 'name'

Resource field to sort paginated response by.

sortDir'asc' | 'desc'

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

Response

Paginated response of environments.

nextPageTokenstring

PageToken to provide for the next page of results.

totalCountinteger

Total number of results.

Changes

No recorded changes to this operation across all 8 revisions of this API.