Update an agent

PATCH

/v1/agents/{id}

curl --request PATCH \
  --url https://example.com/v1/agents/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "external_id": "example", "identity_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "kind": "example", "labels": {}, "metadata": {}, "name": "example", "status": "active", "workspace_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'

• this engine

Updates the mutable fields of one agent from the posted document.

Authorizations

• bearerAuth

Parameters

Path Parameters

id

required

string format: uuid

Resource identifier (UUIDv7).

Header Parameters

X-Olivares-Tenant

string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Request Body ^required

Media type application/json

object

external_id

string

identity_id

string format: uuid

kind

required

string

labels

object

key

additional properties

any

metadata

object

key

additional properties

any

name

required

string

status

string

Allowed values: active inactive archived

workspace_id

string format: uuid

Responses

200

OK

Media type application/json

object

created_at

required

string format: date-time

external_id

string

id

required

string format: uuid

identity_id

string format: uuid

kind

required

string

labels

object

key

additional properties

any

metadata

object

key

additional properties

any

name

required

string

status

required

string

Allowed values: active inactive archived

tenant_id

required

string format: uuid

updated_at

required

string format: date-time

version

required

integer format: int64

workspace_id

string format: uuid

Example

{
  "status": "active"
}

400

Bad request

Media type application/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

401

Unauthenticated

Media type application/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

Forbidden

Media type application/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

404

Not found

Media type application/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

409

Conflict / setup required

Media type application/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

429

Rate limited

Media type application/json

object

error

required

object

code

required

string

message

required

string

Example ^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}