List runs
GET
/api/automation/runsAdministratorRead-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.
Query parameters
| Name | Type | Required | Notes |
|---|---|---|---|
page | integer | Optional | Default 0 |
size | integer | Optional | Default 20 |
Response
Success: 200
| Field | Type | Required | Notes |
|---|---|---|---|
items | array of AutomationRunView | Optional | |
items[].id | string (uuid) | Optional | |
items[].ruleId | string (uuid) | Optional | |
items[].ruleName | string | Optional | |
items[].releaseId | string (uuid) | Optional | |
items[].releaseVersion | string | Optional | |
items[].triggerType | enum TriggerType | Optional | RELEASE_PUBLISHEDMANUALSCHEDULED_CRONUPCOMING_RELEASE_REMINDEREXTERNAL_WEBHOOK |
items[].requestId | string (uuid) | Optional | |
items[].initiatorName | string | Optional | |
items[].status | enum ExecutionStatus | Optional | PENDINGRUNNINGSUCCEEDEDFAILEDUNKNOWNCANCELLEDSKIPPED |
items[].cancellationRequested | boolean | Optional | |
items[].createdAt | string (date-time) | Optional | |
items[].startedAt | string (date-time) | Optional | |
items[].completedAt | string (date-time) | Optional | |
items[].actions | array of AutomationActionRunView | Optional | |
page | integer | Optional | |
size | integer | Optional | |
total | integer | Optional |
Errors
| Status | Code | Applies to |
|---|---|---|
400 | validation_faileda field is missing or out of range | Any endpoint |
400 | invalid_parametera path or query parameter is missing or does not convert, such as an ID that is not a UUID | Any endpoint |
401 | authentication_requiredno session | Any endpoint |
403 | access_deniedan administrator endpoint, or a missing or stale CSRF token | Any endpoint |
404 | not_foundno such address | Any endpoint |
405 | method_not_allowedthe address does not take that method | Any endpoint |
415 | unsupported_media_typethe address does not read a body of that type | Any endpoint |
500 | internal_errora fault ReleaseFlow did not foresee; the body never carries the exception behind it | Any endpoint |
400, 404, 409 | See the guide | Automation 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
200Example
{
"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
}