Environments

Update an environment

Updates an environment's settings.

patch/projects/{project_id}/environments/{environment_id}

Request

Path parameters

project_idstring required
Example:Xk9mZp

Project ID

environment_idstring required
Example:En6tRm

Environment ID

Request body

namestring

Can only be sent with its current value; an environment can't be renamed.

notificationsboolean nullable

Whether errors in this environment notify. Null resets it to true.

Example request

{
  "name": "production"
}

Response

Success

Example response

{
  "data": {
    "id": "En6tRm",
    "project_id": "Xk9mZp",
    "name": "production"
  },
  "meta": {
    "request_id": "6f1c2b0e-8d4a-4f6e-9b2a-3c5d7e9f1a2b"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.