Release Run Queue Items

Method: POST

Endpoint: /api/v2/run-queue/items/release

Authentication: Supports Authorization: Bearer <YOUR_API_KEY>, api-key: <YOUR_API_KEY>, and ?token=<YOUR_API_KEY>. Prefer Bearer token.

Try it

POST/api/v2/run-queue/items/releaseRelease run queue items

AuthenticationRequired

Auth mode

Authorization: Bearerapi-key headerQuery token

API token

Stored only in this browser tab. Sent only to https://openapi.coreclaw.com.

Request BodyRequiredapplication/json

FieldTypeRequiredDescription

queue_refsarrayRequiredQueue item IDs.

reasonstringOptionalRelease reason.

Request body (JSON)Reset to example

{ "queue_refs": [], "reason": "YOUR_REASON" }

Send Request Clear all

When to use this endpoint

Use this endpoint to remove one or more runs from the Run Queue so they never execute — for example, when you no longer need a waiting run. This is the batch version: pass multiple queue_ref values in one call. To release just one item, use Release One Run Queue Item instead.

First call List Run Queue Items to get the queue_ref of the items you want to release.

Request Body

Send the request body with Content-Type: application/json.

Field	Required	Type	Description
queue_refs	Yes	array<string>	The queue item IDs to release. Copy these from the queue_ref values returned by List Run Queue Items.
reason	No	string	Optional reason for releasing, recorded for your later reference.

JSON Example

{
  "queue_refs": ["123456", "123457"],
  "reason": "no longer needed"
}

Request Example

curl -X POST "https://openapi.coreclaw.com/api/v2/run-queue/items/release" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{"queue_refs":["123456","123457"],"reason":"no longer needed"}'

Response Example

{
  "code": 0,
  "data": {
    "results": [
      { "queue_ref": "123456", "success": true },
      { "queue_ref": "123457", "success": false, "error": "item is not in waiting state" }
    ]
  },
  "message": "success",
  "request_id": "req-123"
}

Response Fields

Field	Type	Description
data.results[]	array	Per-item release outcomes, one entry per queue_ref you submitted.
data.results[].queue_ref	string	The queue item ID this result refers to.
data.results[].success	boolean	Whether the item was released. false when the item was no longer in a releasable state (for example it already ran or was activated).
data.results[].error	string	Optional. Present only when success is false, with a short reason why the item could not be released.

Notes

• API v2 supports Bearer token, the legacy api-key header, and query token. Prefer Bearer token for new integrations.
• Releasing is permanent: the item is removed from the queue and will not run. If you want the run to execute instead, use Activate Run Queue Items.
• See Run Lifecycle & Status for status handling and cancellation behavior.

HTTP Responses

HTTP Status	Application Code	Meaning
200	0	OK
400	11000	Bad Request
401	12001	Unauthorized
404	11004	Not Found
422	11000	Unprocessable Entity
429	13000	Too Many Requests
500	10000	Internal Server Error