Edit agent governance metadata without making the agent callable unless it remains approved.
PATCH /v1/agents/{agent_id}
PATCH
/v1/agents/{agent_id}
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” agent_id
required
string
Query Parameters
Section titled “Query Parameters ” tenant_id
string
environment_id
string
Request Body required
Section titled “Request Body required ”Accepts the snake_case admin shape below and the legacy Agent manifest shape from ../jsonschema/agent.schema.json.
object
tenant_id
string
environment_id
string
agent_id
string
name
string
purpose
string
owner
object
team
required
string
escalation_contact
required
string
owner_team
string
escalation_contact
string
allowed_surfaces
Array<string>
allowed_environments
Array<string>
delegation_mode
string
credential_mode
string
instance_identity
object
required
required
boolean
allowed_instance_ids
required
Array<string>
allowed_instance_id_prefixes
required
Array<string>
key
additional properties
any
Responses
Section titled “ Responses ”Agent edit accepted and audited.
object
schema_version
required
accepted
required
boolean
agent
required
object
schema_version
required
agent_id
required
string
name
required
string
purpose
string | null
tenant_id
required
string
environment_id
required
string
lifecycle_state
required
approval_status
required
string
owner
required
object
team
required
string
escalation_contact
required
string
allowed_surfaces
required
Array<string>
allowed_environments
required
Array<string>
delegation_mode
required
string
credential_mode
required
string
instance_identity
required
object
required
required
boolean
allowed_instance_ids
required
Array<string>
allowed_instance_id_prefixes
required
Array<string>
submitted_by
required
string
submitted_at
required
string format: date-time
reviewed_by
string | null
reviewed_at
string | null format: date-time
review_reason_code
string | null
review_reason
string | null
disabled_at
string | null format: date-time
archived_at
string | null format: date-time
revoked_at
string | null format: date-time
revocation_id
string | null
created_at
required
string format: date-time
updated_at
required
string format: date-time
permissions
required
object
resource_type
required
resource_id
required
string
allowed_actions
required
Array
audit_event_ids
required
Array<string>
revocation_id
required
string | null
affected_client_session_ids
required
Array<string>
Type set in Geist, Source Serif 4, and Departure Mono.