Skip to content
Proud to collaborate with Microsoft for Startups

aria.suspend ​

Suspend a published service; the endpoint stops answering within one cache TTL.

Take a published service off the air without deleting it.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-aria
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
slugstringYes——

Output Schema ​

FieldTypeRequiredDefaultDescription
servicejsonNo—The service after the change
failure_reasonstringNo——
failed_at_statestringNo——
failed_stepjsonNo——
failed_layerintegerNo——
errorstringNo——
error_typestringNo——
failed_atstringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

Outcomes ​

OutcomeTypeDescriptionState Data Keys
suspendedSUCCESSThe service stopped answeringservice
failedFAILUREThe action was refused or failedfailure_reason

Business Errors ​

CodeMessage Template
ARIA_SERVICE_NOT_FOUNDNo such service in this organization
ARIA_INVALID_STATEThe service is not in a state where that makes sense

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "aria.suspend",
  "initial_data": {
    "slug": "value"
  }
}