Update environment

POST /api/v1/app/{appId}/env/{envId}

Update Environment

Updates a Stackhawk Environment

Currently, can only change an environment name.

👥 Teams Supported If the application belongs to a StackHawk Team, only members of the Team can call this endpoint.

🧾 Audited This is recorded as ENVIRONMENT_MODIFIED User Activity.

Requires write:application permission.

Path parameters

appIdstring · uuidrequired

UUID identifier for this StackHawk Application.

envIdstring · uuidrequired

UUID identifier for this StackHawk Environment.

Body

applicationId

string read-only

The UUID identifier of this application.

dataType

enum<string> read-only

updated riskLevel for this environment.

7 available options

NONEPIIPCIFINPKIHIPAAFERPA

envId

string read-only

The UUID identifier of this environment.

name

string required

updated name for this environment.

riskLevel

enum<string> read-only

updated riskLevel for this environment.

4 available options

LOWMEDIUMHIGHCRITICAL

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

POST /api/v1/app/{appId}/env/{envId}

cURL

curl --request POST \
  --url 'https://api.stackhawk.com/api/v1/app/{appId}/env/{envId}' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{}'

Copy

Update environment