Skip to main content

Agents

Agents are software components that run alongside your API gateways and handle communication between the gateway and the Control Plane.

List agents​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/agents?page=1&size=10" \
  -H "Authorization: Bearer <your-token>"

Register an agent​

curl -X POST "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/agents" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "kong-agent-01",
    "displayName": "Kong Agent 01"
  }'

Get an agent​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/agents/<agent-id>" \
  -H "Authorization: Bearer <your-token>"

Update an agent​

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/agents/<agent-id>" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "kong-agent-01",
    "displayName": "Kong Agent 01 (Primary)"
  }'

Delete an agent​

curl -X DELETE "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/agents/<agent-id>" \
  -H "Authorization: Bearer <your-token>"

Agent tokens​

Agents use tokens to authenticate with the Control Plane.

Generate an agent token​

curl -X POST "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/agents/<agent-id>/token" \
  -H "Authorization: Bearer <your-token>"
caution

The agent token is only returned once at generation time. Store it securely.

Revoke an agent token​

curl -X DELETE "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/agents/<agent-id>/token" \
  -H "Authorization: Bearer <your-token>"

Agent build info​

Retrieve the build information and capabilities of a connected agent:

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/agents/<agent-id>/buildInfo" \
  -H "Authorization: Bearer <your-token>"

Agent capabilities​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/agents/<agent-id>/capabilities" \
  -H "Authorization: Bearer <your-token>"