Skip to main content
PATCH
Update an agent deployment

Authorizations

Authorization
string
header
required

API key passed as Bearer token

Path Parameters

deployment_id
string
required

Agent deployment ID

Body

application/json
name
string
Required string length: 1 - 128
description
string | null
status
enum<string>
Available options:
active,
paused,
deleted
active_version_id
string | null
metadata
object

Free-form user-supplied metadata; stored verbatim as arbitrary JSON and never interpreted by the server, so the shape is deliberately open.

Response

Updated agent deployment

id
string
required
Example:

"adpl_1234abcd"

name
string
required
mode
enum<string>
required
Available options:
job,
service
status
enum<string>
required
Available options:
active,
paused,
deleted
metadata
object
required

Free-form user-supplied metadata; stored verbatim as arbitrary JSON and never interpreted by the server, so the shape is deliberately open.

created_at
string<date-time>
required
updated_at
string<date-time>
required
description
string | null
active_version_id
string | null
deleted_at
string<date-time> | null