List Applications

GET /api/v1/app/{orgId}/list deprecated

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

Lists applications that belong to this organization.

Returns a paginated list of Applications.

Parameter	Default	Description
applications	[]	List of applications.
nextPageToken	""	PageToken to provide for the next page of results.
totalCount	0	Total number of results.

Application

Applications group scan results from HawkScan, and coordinate settings to influence HawkScan behavior. The application may also contain a specific environment name and id. For more information, see Applications.

Parameter	Default	Description
applicationId	""	The UUID identifier of this application.
name	""	The name of this application.
env	""	The name of this environment. Only set when requesting Application Environments.
envId	""	The UUID identifier of this environment.
applicationStatus	"ACTIVE"	The status of this application. Either ACTIVE or ENV_INCOMPLETE.
organizationId	""	The UUID identifier of the organization that owns this application.
applicationType	"STANDARD"	The type of this application.
cloudScanTarget	{}	Optional Cloud Scan Target configuration.

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

Requires read:application permission.

Path parameters

orgIdstring · uuidrequired

UUID identifier for this StackHawk Organization.

Query parameters

appIdsstring[]

A comma-delimited list of UUID identifiers of StackHawk Applications.

envsstring[]

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

teamIdsstring[]

A comma-delimited list of UUID identifiers of StackHawk Teams to filter by.

ignoreEnvsboolean

If enabled returns a shortened list of applications, omiting environment entries.

default: false

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

nameid

sortDirstring

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

2 available options

ascdesc

Response

Paginated response of applications.

applications

application.Application[]

List of applications.

Hide child attributesShow child attributes

applications.applicationId

string

The UUID identifier of this application.

applications.applicationStatus

enum<string>

The status of this application. Either ACTIVE or ENV_INCOMPLETE.

2 available options

ACTIVEENV_INCOMPLETE

applications.applicationType

enum<string>

The type of this application.

2 available options

STANDARDCLOUD

applications.cloudScanTarget

application.CloudScanTarget

Hide child attributesShow child attributes

applications.cloudScanTarget.isDomainVerified

boolean

Indicates if the domain is verified or not.

applications.cloudScanTarget.targetURL

string

The target URL.

applications.dataType

enum<string> write-only

The perceived dataType of this application. Currently unused.

7 available options

NONEPIIPCIFINPKIHIPAAFERPA

applications.env

string

The name of this environment. Only set when requesting Application Environments.

applications.envId

string

The UUID identifier of this environment.

applications.name

string

The name of this application.

applications.organizationId

string

The UUID identifier of the organization that owns this application.

applications.riskLevel

enum<string> write-only

The perceived riskLevel of this application. Currently unused.

4 available options

LOWMEDIUMHIGHCRITICAL

nextPageToken

string

PageToken to provide for the next page of results.

totalCount

integer<int64>

Total number of results.

applications

application.Application[]

List of applications.

Hide child attributesShow child attributes

applications.applicationId

string

The UUID identifier of this application.

applications.applicationStatus

enum<string>

The status of this application. Either ACTIVE or ENV_INCOMPLETE.

2 available options

ACTIVEENV_INCOMPLETE

applications.applicationType

enum<string>

The type of this application.

2 available options

STANDARDCLOUD

applications.cloudScanTarget

application.CloudScanTarget

Hide child attributesShow child attributes

applications.cloudScanTarget.isDomainVerified

boolean

Indicates if the domain is verified or not.

applications.cloudScanTarget.targetURL

string

The target URL.

applications.dataType

enum<string> write-only

The perceived dataType of this application. Currently unused.

7 available options

NONEPIIPCIFINPKIHIPAAFERPA

applications.env

string

The name of this environment. Only set when requesting Application Environments.

applications.envId

string

The UUID identifier of this environment.

applications.name

string

The name of this application.

applications.organizationId

string

The UUID identifier of the organization that owns this application.

applications.riskLevel

enum<string> write-only

The perceived riskLevel of this application. Currently unused.

4 available options

LOWMEDIUMHIGHCRITICAL

nextPageToken

string

PageToken to provide for the next page of results.

totalCount

integer<int64>

Total number of results.

Unauthorized

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

cURL

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

Copy

List Applications