Skip to main content
PATCH
/
api
/
v1
/
environments
/
{environment_id}
Update Environment
curl --request PATCH \
  --url https://control-plane.kubiya.ai/api/v1/environments/{environment_id} \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "display_name": "<string>",
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "settings": {},
  "status": "<string>",
  "execution_environment": {
    "env_vars": {},
    "secrets": [
      "<string>"
    ],
    "integration_ids": [
      "<string>"
    ]
  }
}'
{
  "id": "<string>",
  "organization_id": "<string>",
  "name": "<string>",
  "display_name": "<string>",
  "description": "<string>",
  "tags": [
    "<string>"
  ],
  "settings": {},
  "status": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "created_by": "<string>",
  "worker_token": "<string>",
  "provisioning_workflow_id": "<string>",
  "provisioned_at": "<string>",
  "error_message": "<string>",
  "temporal_namespace_id": "<string>",
  "active_workers": 0,
  "idle_workers": 0,
  "busy_workers": 0,
  "skill_ids": [],
  "skills": [],
  "execution_environment": {}
}

Path Parameters

environment_id
string
required

Body

application/json
name
string | null
display_name
string | null
description
string | null
tags
string[] | null
settings
object | null
status
string | null
execution_environment
object | null

Execution environment configuration - env vars, secrets, and integration credentials

Response

Successful Response

id
string
required
organization_id
string
required
name
string
required
display_name
string | null
required
description
string | null
required
tags
string[]
required
settings
object
required
status
string
required
created_at
string
required
updated_at
string
required
created_by
string | null
required
worker_token
string | null
provisioning_workflow_id
string | null
provisioned_at
string | null
error_message
string | null
temporal_namespace_id
string | null
active_workers
integer
default:0
idle_workers
integer
default:0
busy_workers
integer
default:0
skill_ids
string[]
skills
Skills · object[]
execution_environment
object