Skip to main content

Create Agent Runner

POST 
/api/automation/runners

Register a new agent runner and issue its token.

Required scope: settings:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

The token is returned only in this response - store it on the runner machine immediately; it cannot be read again (use Rotate Agent Runner Token to issue a new one). The runner sends it as Authorization: Bearer <token> to the Agent Runner Job API.

Requires the workflows.index permission.

Body

  • name (required, string, max 120) - e.g. the machine's name.
  • mode (optional) - attended (a person confirms each job on the machine) or unattended (default).

Returns 201 with the runner and its token, 403 without permission, 422 for validation errors.

Request​

Responses​

Created

Response Headers
    Content-Type