Add an agent to a group. Idempotent: 200 with the existing row when already a member, 201 for a fresh add

PUT

/v1/agent-groups/{id}/members/{agentID}

curl --request PUT \
  --url https://example.com/v1/agent-groups/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/members/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

• this engine

Adds an agent to a group. Idempotent by an exact (group, agent) lookup: an already-member returns the existing row with 200, a fresh add returns 201; an unknown agent is a 404, not a dangling membership.

Authorizations

• bearerAuth
• browserSession

Parameters

Path Parameters

id

required

string format: uuid

Resource identifier (UUIDv7).

agentID

required

string format: uuid

Agent identifier (UUIDv7).

Header Parameters

X-Olivares-Tenant

string format: uuid

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

Responses

200

OK

Media type application/json

object

agent_id

required

string format: uuid

group_id

required

string format: uuid

id

required

The membership row’s id.

string format: uuid

Example ^generated

{
  "agent_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "group_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

201

Created

Media type application/json

object

agent_id

required

string format: uuid

group_id

required

string format: uuid

id

required

The membership row’s id.

string format: uuid

Example ^generated

{
  "agent_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "group_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

400

Bad request

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

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

401

Unauthenticated

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

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

403

Forbidden

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

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

404

Not found

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

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

409

Conflict / setup required

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

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

429

Rate limited

Media type application/json

object

error

required

object

code

required

string

message

required

string

module

With code module_not_enabled: the namespace of the module this node does not run.

string

Example ^generated

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