StackHawk Documentation StackHawk Logo HawkDocs

No results found

Try different keywords or check your spelling

Search documentation

Find guides, API references, and more

esc

Create application

POST /api/v1/org/{orgId}/app

Create Application

Creates a new Stackhawk Application for this organization.

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 env and envId fields are not populated on the response with this endpoint. A name is not required to create an application, but it is strongly encouraged.

👥 Teams Supported If the user belongs to a StackHawk Team, a created application will belong to the user's Team.

🧾 Audited This is recorded as APPLICATION_ADDED User Activity.

Requires write:application permission.

Path parameters

orgIdstring · uuidrequired

UUID identifier for this StackHawk Organization.

Body

applicationStatus
enum<string> read-only

A specified status for this new application.

2 available options
ACTIVEENV_INCOMPLETE
applicationType
enum<string>

A specified status for this new application.

2 available options
STANDARDCLOUD
cloudScanTargetURL
string

Optional Cloud Scanning Target URL.

dataType
enum<string> read-only

A specified data type for this new application.

7 available options
NONEPIIPCIFINPKIHIPAAFERPA
env
string required

The initial environment for this new application.

host
string

The host specified when creating a new application

name
string required

The name of this new application.

organizationId
string read-only

The UUID identifier of the organization that will own this application.

riskLevel
enum<string> read-only

A specified risk level for this new application.

4 available options
LOWMEDIUMHIGHCRITICAL
teamId
string

The UUID identifier of the team that this application belongs to.

Response

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.

applicationId
string

The UUID identifier of this application.

applicationStatus
enum<string>

The status of this application. Either ACTIVE or ENV_INCOMPLETE.

2 available options
ACTIVEENV_INCOMPLETE
applicationType
enum<string>

The type of this application.

2 available options
STANDARDCLOUD
cloudScanTarget
application.CloudScanTarget
Hide child attributesShow child attributes
cloudScanTarget.isDomainVerified
boolean

Indicates if the domain is verified or not.

cloudScanTarget.targetURL
string

The target URL.

dataType
enum<string> write-only

The perceived dataType of this application. Currently unused.

7 available options
NONEPIIPCIFINPKIHIPAAFERPA
env
string

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

envId
string

The UUID identifier of this environment.

name
string

The name of this application.

organizationId
string

The UUID identifier of the organization that owns this application.

riskLevel
enum<string> write-only

The perceived riskLevel of this application. Currently unused.

4 available options
LOWMEDIUMHIGHCRITICAL
applicationId
string

The UUID identifier of this application.

applicationStatus
enum<string>

The status of this application. Either ACTIVE or ENV_INCOMPLETE.

2 available options
ACTIVEENV_INCOMPLETE
applicationType
enum<string>

The type of this application.

2 available options
STANDARDCLOUD
cloudScanTarget
application.CloudScanTarget
Hide child attributesShow child attributes
cloudScanTarget.isDomainVerified
boolean

Indicates if the domain is verified or not.

cloudScanTarget.targetURL
string

The target URL.

dataType
enum<string> write-only

The perceived dataType of this application. Currently unused.

7 available options
NONEPIIPCIFINPKIHIPAAFERPA
env
string

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

envId
string

The UUID identifier of this environment.

name
string

The name of this application.

organizationId
string

The UUID identifier of the organization that owns this application.

riskLevel
enum<string> write-only

The perceived riskLevel of this application. Currently unused.

4 available options
LOWMEDIUMHIGHCRITICAL

Bad Request

Unauthorized

Your privacy settings

We use first and third party cookies to ensure that we give you the best experience on our website and in our products.