Create a runbook-execution

POST

/runbook-executions

• Current canonical versioned path (F3.API.01)

Authorizations

• bearerAuth
• apiTokenAuth

Request Body ^required

object

data

object

runbook

One of:

string

DocumentId reference to api::runbook.runbook

string

object

object

key

additional properties

any

organisation

One of:

string

DocumentId reference to api::organisation.organisation

string

object

object

key

additional properties

any

triggered_by

required

string

Allowed values: alert manual

status

required

string

Allowed values: pending dry_run running completed failed cancelled

result

Execution result payload from agent. Array of {action, success, output, error}.

dry_run

boolean

approved_at

string format: date-time

expires_at

Approval TTL — execution is auto-cancelled if not approved by this time (now+4h on create when confirmation_required).

string format: date-time

approval_token

string

agent_target

Agent_id (documentId) of the agent to execute the runbook on.

string

error_message

string

triggered_by_user

One of:

string

DocumentId reference to plugin::users-permissions.user

string

object

object

key

additional properties

any

Responses

200

Created

object

data

object

runbook

One of:

string

DocumentId reference to api::runbook.runbook

string

object

object

key

additional properties

any

organisation

One of:

string

DocumentId reference to api::organisation.organisation

string

object

object

key

additional properties

any

triggered_by

required

string

Allowed values: alert manual

status

required

string

Allowed values: pending dry_run running completed failed cancelled

result

Execution result payload from agent. Array of {action, success, output, error}.

dry_run

boolean

approved_at

string format: date-time

expires_at

Approval TTL — execution is auto-cancelled if not approved by this time (now+4h on create when confirmation_required).

string format: date-time

approval_token

string

agent_target

Agent_id (documentId) of the agent to execute the runbook on.

string

error_message

string

triggered_by_user

One of:

string

DocumentId reference to plugin::users-permissions.user

string

object

object

key

additional properties

any

documentId

string

id

integer

createdAt

string format: date-time

updatedAt

string format: date-time

publishedAt

string format: date-time

nullable

400

Validation error

401

Missing or invalid authentication

403

Not authorized (tenant scope or capability)