Skip to main content

List runs

GET/api/automation/runs
AdministratorRead-only

POST /{id}/execute answers 202 with the run. The request ID is yours to choose and is the promise that a repeat is the same run rather than a second delivery. DELETE /api/automation/rules/{id} archives a rule, which cancels the runs it had not finished and frees its name. GET /api/automation/runs answers {"items", "page", "size", "total"}, with size between 1 and 100.

Read more: RESTSource: AutomationRunApiController#list(opens in new tab)

Query parameters​

NameTypeRequiredNotes
pageintegerOptionalDefault 0
sizeintegerOptionalDefault 20

Response​

Success: 200

FieldTypeRequiredNotes
itemsarray of AutomationRunViewOptional
items[].idstring (uuid)Optional
items[].ruleIdstring (uuid)Optional
items[].ruleNamestringOptional
items[].releaseIdstring (uuid)Optional
items[].releaseVersionstringOptional
items[].triggerTypeenum TriggerTypeOptionalRELEASE_PUBLISHEDMANUALSCHEDULED_CRONUPCOMING_RELEASE_REMINDEREXTERNAL_WEBHOOK
items[].requestIdstring (uuid)Optional
items[].initiatorNamestringOptional
items[].statusenum ExecutionStatusOptionalPENDINGRUNNINGSUCCEEDEDFAILEDUNKNOWNCANCELLEDSKIPPED
items[].cancellationRequestedbooleanOptional
items[].createdAtstring (date-time)Optional
items[].startedAtstring (date-time)Optional
items[].completedAtstring (date-time)Optional
items[].actionsarray of AutomationActionRunViewOptional
pageintegerOptional
sizeintegerOptional
totalintegerOptional

Errors​

StatusCodeApplies to
400validation_faileda field is missing or out of rangeAny endpoint
400invalid_parametera path or query parameter is missing or does not convert, such as an ID that is not a UUIDAny endpoint
401authentication_requiredno sessionAny endpoint
403access_deniedan administrator endpoint, or a missing or stale CSRF tokenAny endpoint
404not_foundno such addressAny endpoint
405method_not_allowedthe address does not take that methodAny endpoint
415unsupported_media_typethe address does not read a body of that typeAny endpoint
500internal_errora fault ReleaseFlow did not foresee; the body never carries the exception behind itAny endpoint
400, 404, 409See the guideAutomation area

Request

bash
# Sign in first and keep the session cookie in cookies.txt (see Sessions and CSRF).
curl "http://localhost:8080/api/automation/runs" \
-b cookies.txt -c cookies.txt

Response

200

Example

{
  "items": [
    {
      "id": "<uuid>",
      "ruleId": "<uuid>",
      "ruleName": "<string>",
      "releaseId": "<uuid>",
      "releaseVersion": "<string>",
      "triggerType": "RELEASE_PUBLISHED",
      "requestId": "<uuid>",
      "initiatorName": "<string>",
      "status": "PENDING",
      "cancellationRequested": false,
      "createdAt": "<date-time>",
      "startedAt": "<date-time>",
      "completedAt": "<date-time>",
      "actions": [
        {}
      ]
    }
  ],
  "page": 0,
  "size": 0,
  "total": 0
}