コンテンツにスキップ
Authrim

Cancel a logging message job

POST
/api/admin/logging-policies/message-jobs/{id}/cancel
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/logging-policies/message-jobs/example/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "reason": "Operator cancelled duplicate retry." }'

Request cancellation for a queued, retrying, claimed, or running logging message job. Export-build jobs may enqueue cleanup work.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Request Body

Section titled “Request Body ”

Cancel a queued, retrying, claimed, or running logging message job.

Media type application/json
object
reason
string
key
additional properties
Example 
{
  "reason": "Operator cancelled duplicate retry."
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Message job action result.

Media type application/json
object
result
required
object
key
additional properties
audit_id
One of:
string
job_id
string
key
additional properties
Example 
{
  "result": {
    "id": "lmj_123",
    "kind": "retry_delivery",
    "status": "cancelled",
    "lane": "default",
    "criticality": "standard",
    "priority": 10,
    "tenant_key": "tenant_123",
    "topology_type": "shared",
    "scope_type": "tenant",
    "scope_id": "tenant_123",
    "scope_key": "tenant_123",
    "source_type": "dlq_item",
    "source_id": "dlq_123",
    "root_job_id": null,
    "parent_job_id": null,
    "depth": 0,
    "payload_object_ref": "logging-message-payloads/lmj_123.json",
    "payload_sha256": "sha256:abc123",
    "payload_type": "retry_delivery",
    "payload_schema_version": 1,
    "redacted_summary": {
      "event_count": 1
    },
    "validation_summary": {
      "valid": true
    },
    "idempotency_key": "retry:dlq_123",
    "dedupe_until": 1770003600000,
    "not_before": 1770000000000,
    "attempt_count": 0,
    "max_attempts": 5,
    "attempt_policy": {
      "maxAttempts": 5,
      "leaseTimeoutMs": 600000
    },
    "has_claim_token": false,
    "claimed_at": null,
    "claimed_until": null,
    "requested_by": "admin_123",
    "reason": "manual retry",
    "error_class": null,
    "last_error": null,
    "blocked_reason": null,
    "cancel_requested_at": 1770000500000,
    "cancelled_by": "admin_123",
    "created_at": 1770000000000,
    "updated_at": 1770000000000,
    "started_at": null,
    "completed_at": null,
    "expires_at": 1770086400000
  },
  "audit_id": "audit_123"
}

default

Section titled “default ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}