Skip to main content

Update an Environment

note

This endpoint can only be accessed using an Admin Key.

Update an environment given its environmentId.

Endpoint
PUT /v2/environments/:environmentId

Request​

Path Params​

environmentId string

The environmentId of the environment to update.

Body​

name string

Customer defined name for this environment.

PUT /v2/environments/:environmentId
curl "https://api.warrant.dev/v2/environments/staging" \
    -X PUT \
    -H "Authorization: ApiKey YOUR_KEY" \
    --data-raw \
    '{
        "name": "Staging Environment"
    }'

Response​

Body​

environmentId string

Customer defined string identifier for this environment. Can only contain alphanumeric chars and/or '-'.

name string

Customer defined name for this environment.

200 OK
{
  "environmentId": "staging",
  "name": "Staging Environment"
}