Cancel a pending task

: "${MOBIUS_API_BASE_URL:?Set the API URL from your app}"
: "${MOBIUS_API_KEY:?Set your API key locally}"
: "${TASK_ID:?Set the task UUID}"
: "${IDEMPOTENCY_KEY:?Generate and persist an ID before this mutation}"

curl -i "$MOBIUS_API_BASE_URL/v1/delta-neutral/tasks/$TASK_ID/cancel" \
  -H "Authorization: Bearer $MOBIUS_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{
  "taskId": "00000000-0000-4000-8000-000000000001",
  "status": "cancelled"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

POST

delta-neutral

tasks

{taskId}

cancel

: "${MOBIUS_API_BASE_URL:?Set the API URL from your app}"
: "${MOBIUS_API_KEY:?Set your API key locally}"
: "${TASK_ID:?Set the task UUID}"
: "${IDEMPOTENCY_KEY:?Generate and persist an ID before this mutation}"

curl -i "$MOBIUS_API_BASE_URL/v1/delta-neutral/tasks/$TASK_ID/cancel" \
  -H "Authorization: Bearer $MOBIUS_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{
  "taskId": "00000000-0000-4000-8000-000000000001",
  "status": "cancelled"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

Send {}. Cancellation is available only before the worker claims a pending task. For a running task, use close.

: "${MOBIUS_API_BASE_URL:?Set the API URL from your app}"
: "${MOBIUS_API_KEY:?Set your API key locally}"
: "${TASK_ID:?Set the task UUID}"
: "${IDEMPOTENCY_KEY:?Generate and persist an ID before this mutation}"

curl -i "$MOBIUS_API_BASE_URL/v1/delta-neutral/tasks/$TASK_ID/cancel" \
  -H "Authorization: Bearer $MOBIUS_API_KEY" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Authorizations

Authorization

string

header

required

API key created in this environment: mobius_.. Keep it in a local environment variable; never commit it.

Headers

Idempotency-Key

string

required

Persist one ID per intended mutation before sending. Reuse it with the same request for retries; different content returns 409.

Required string length: 1 - 128

Pattern: ^[!-~]+$

Path Parameters

taskId

string<uuid>

required

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Body

application/json

The body is of type object.

Response

Command accepted. Inspect task status for execution.

taskId

string<uuid>

required

status

string

required

Allowed value: "cancelled"

User Guide

Introduction

Protocol

Strategies

API reference

Cancel a pending task

Authorizations

Headers

Path Parameters

Body

Response