Skip to main content

Archive rule

DELETE/api/automation/rules/{ruleId}
Administrator

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

Path parameters​

NameTypeRequiredNotes
ruleIdstring (uuid)Required

Response​

Success: 204

No response body.

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).
# CSRF_HEADER and CSRF_TOKEN are the headerName and token GET /api/csrf returned.
curl -X DELETE "http://localhost:8080/api/automation/rules/$RULE_ID" \
-b cookies.txt -c cookies.txt \
-H "$CSRF_HEADER: $CSRF_TOKEN"

Response

204

No response body.