Create environment

Create Environment

Creates a new Stackhawk Environment for this application.

This is represented as a StackHawk Application with populated env and envId fields.

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.

ParameterDefaultDescription
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.
šŸ‘„

Teams Supported

If the user belongs to a StackHawk Team, a created environment will belong to the user's Team.

🧾

Audited

This is recorded as ENVIRONMENT_ADDED User Activity.

Requires write:application permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

UUID identifier for this StackHawk Application.

Query Params
string

Optional host URL for the new environment's default hosted scan configuration.

Body Params

Request to create a new StackHawk Environment for an existing application.

string

The name of this new environment.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400

Bad Request

401

Unauthorized

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/x-protobuf