Update an environment

POST /api/v1/cloud/environments/{environment_id} Updates the properties of the specified environment (name, description, configuration, and so on).

Headers

Header	Required	Description
`Authorization`	Yes	`Bearer <PAT or SAT>`
`Content-Type`	Yes	`application/json`

Path parameters

Parameter	Type	Required	Description
`environment_id`	string	Yes	Environment unique identifier (with the `env_` prefix)

Request body

Only the fields included in the request are updated; omitted fields remain unchanged.

Field	Type	Required	Description
`name`	string	No	Environment name
`description`	string	No	Environment description
`config`	Environment config	No	Replaces the stored environment configuration
`metadata`	object	No	Metadata patch. String values upsert keys; `null` values delete keys from stored metadata

Example request

curl -s -X POST 'https://api.qoder.com/api/v1/cloud/environments/env_019e3bb39b6774d8878cd0b9d237574b' \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
    "description": "Environment used for API documentation testing"
  }'

Example response

HTTP 200 OK

{
  "id": "env_019e3bb39b6774d8878cd0b9d237574b",
  "type": "environment",
  "name": "doc-test-env",
  "description": "Environment used for API documentation testing",
  "config": {
    "type": "cloud",
    "packages": {
      "type": "packages",
      "apt": ["curl"],
      "cargo": [],
      "gem": [],
      "go": [],
      "npm": [],
      "pip": []
    }
  },
  "metadata": {},
  "archived_at": null,
  "created_at": "2026-05-18T15:28:07.017808Z",
  "updated_at": "2026-05-18T15:28:08.093156Z"
}

Response fields

Field	Type	Description
`id`	string	Environment unique identifier
`type`	string	Always `"environment"`
`name`	string	Environment name
`description`	string	Updated description
`config`	Environment config	Environment configuration
`metadata`	Metadata object	Custom metadata
`archived_at`	string\|null	Archive time (ISO 8601), `null` when not archived
`created_at`	string	Creation time (ISO 8601)
`updated_at`	string	Last update time (refreshed)

Errors

HTTP	Type	Trigger
400	`invalid_request_error`	Invalid request body, `config`, or `metadata` value
401	`authentication_error`	PAT or SAT invalid or expired
403	`permission_error`	Not authorized for this resource
404	`not_found_error`	Environment with the given ID does not exist

See Errors for the full error envelope.

Notes

Omitted fields remain unchanged.
When config is provided, it replaces the stored configuration.
When metadata is provided, string values are merged into the stored metadata object and null values delete existing keys.

Cloud environment setup

Choose the container, network, and dependencies your agent runs in.

​Headers

​Path parameters

​Request body

​Example request

​Example response

​Response fields

​Errors

​Notes

​Related