Bind an agent to a state on a database; returns the binding record

POST

/api/v1/workspaces/{ws}/agents/triggers

Request Body^required

Media typeapplication/json

object

agent

required

string

>= 1 characters

database_id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

state_field_id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

state_option_id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

human_gate

boolean

enabled

boolean

Example^generated

{
  "agent": "example",
  "database_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "state_field_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "state_option_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "human_gate": true,
  "enabled": true
}

Responses

201