Update an environment

Updates an existing environment by ID. Supports updating name, description, and type.

PUT /v1/environments/{id}

Update an environment

cURL

curl --request PUT \
  --url https://api.app.chainloop.dev/v1/environments/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "type": "ENVIRONMENT_TYPE_UNSPECIFIED"
}
'

200

{
  "environment": {
    "updated_at": "2000-01-23T04:56:07.000Z",
    "organization_id": "organization_id",
    "name": "name",
    "description": "description",
    "created_at": "2000-01-23T04:56:07.000Z",
    "id": "id",
    "type": "ENVIRONMENT_TYPE_UNSPECIFIED"
  }
}

Authorizations

Authorization · string · header · required

Bearer token for authentication

Path Parameters

id · string · required

ID is the unique identifier of the environment to update

Body

application/json

name · string

description · string

type · enum<string> · default: ENVIRONMENT_TYPE_UNSPECIFIED

Available options: ENVIRONMENT_TYPE_UNSPECIFIED, ENVIRONMENT_TYPE_KUBERNETES, ENVIRONMENT_TYPE_ECS, ENVIRONMENT_TYPE_SERVER, ENVIRONMENT_TYPE_LAMBDA, ENVIRONMENT_TYPE_CUSTOM

Response

200

application/json

A successful response.

environment · Environment represents an environment entity · object

Show child attributes

Example:

{
  "updated_at": "2000-01-23T04:56:07.000Z",
  "organization_id": "organization_id",
  "name": "name",
  "description": "description",
  "created_at": "2000-01-23T04:56:07.000Z",
  "id": "id",
  "type": "ENVIRONMENT_TYPE_UNSPECIFIED"
}