APIAgents
Create agent
Create a new agent instance. Returns the instance with a plain API token.
POST
/agent-instancesCreate a new agent instance. Returns the instance with a plain API token.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
One connected client of an agent, registered to the user who authorized it. A policy scoped to the agent applies to every instance; one scoped to an instance applies to that connection alone.
Response Body
application/json
application/json
curl -X POST "https://example.com/agent-instances" \ -H "Content-Type: application/json" \ -d '{ "display_name": "string" }'{ "id": null, "user_id": null, "user_display_name": "string", "display_name": "string", "metadata": { "client_name": "string", "client_version": "string", "protocol_version": "string", "user_agent": "string", "ip_address": "string" }, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "last_used_at": "2019-08-24T14:15:22Z", "revoked_at": "2019-08-24T14:15:22Z", "agent_slug": "string", "external_id": "string", "token": "string"}{ "code": "bad_request", "message": "string", "validation_errors": [ { "field": "string", "message": "string", "rule": "string" } ]}