Skip to main content

Execute rule

POST/api/automation/rules/{ruleId}/execute
Administrator

Read more: RESTSource: AutomationRuleApiController#execute(opens in new tab)

Path parameters​

NameTypeRequiredNotes
ruleIdstring (uuid)Required

Request body​

application/json

FieldTypeRequiredNotes
releaseIdstring (uuid)Required
requestIdstring (uuid)Optional

Response​

Success: 202

FieldTypeRequiredNotes
idstring (uuid)Optional
ruleIdstring (uuid)Optional
ruleNamestringOptional
releaseIdstring (uuid)Optional
releaseVersionstringOptional
triggerTypeenum TriggerTypeOptionalRELEASE_PUBLISHEDMANUALSCHEDULED_CRONUPCOMING_RELEASE_REMINDEREXTERNAL_WEBHOOK
requestIdstring (uuid)Optional
initiatorNamestringOptional
statusenum ExecutionStatusOptionalPENDINGRUNNINGSUCCEEDEDFAILEDUNKNOWNCANCELLEDSKIPPED
cancellationRequestedbooleanOptional
createdAtstring (date-time)Optional
startedAtstring (date-time)Optional
completedAtstring (date-time)Optional
actionsarray of AutomationActionRunViewOptional
actions[].idstring (uuid)Optional
actions[].positionintegerOptional
actions[].actionTypeenum ActionTypeOptionalGITHUB_RELEASESLACKEMAILPUBLIC_CHANGELOGNOTIONCONFLUENCEMICROSOFT_TEAMSZENDESK
actions[].audienceNamestringOptional
actions[].languagestringOptional
actions[].statusenum ExecutionStatusOptionalPENDINGRUNNINGSUCCEEDEDFAILEDUNKNOWNCANCELLEDSKIPPED
actions[].externalReferencestringOptional
actions[].errorCodestringOptional
actions[].attemptsintegerOptional
actions[].startedAtstring (date-time)Optional
actions[].completedAtstring (date-time)Optional

Errors​

StatusCodeApplies to
400validation_faileda field is missing or out of rangeAny endpoint
400malformed_requestthe body cannot be readAny 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).
# CSRF_HEADER and CSRF_TOKEN are the headerName and token GET /api/csrf returned.
curl -X POST "http://localhost:8080/api/automation/rules/$RULE_ID/execute" \
-b cookies.txt -c cookies.txt \
-H "$CSRF_HEADER: $CSRF_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"releaseId": "<uuid>",
"requestId": "<uuid>"
}'

The request body is an example built from the schema; replace every placeholder.

Response

202

Example

{
  "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": [
    {
      "id": "<uuid>",
      "position": 0,
      "actionType": "GITHUB_RELEASE",
      "audienceName": "<string>",
      "language": "<string>",
      "status": "PENDING",
      "externalReference": "<string>",
      "errorCode": "<string>",
      "attempts": 0,
      "startedAt": "<date-time>",
      "completedAt": "<date-time>"
    }
  ]
}