Release One Run Queue Item

Method: POST

Endpoint: /api/v2/run-queue/items/{queueId}/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/{queueId}/releaseRelease one run queue item

AuthenticationRequired

Auth mode

Authorization: Bearerapi-key headerQuery token

API token

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

Parameters

queueIdpath · stringRequired

Queue item ID.

Request BodyRequiredapplication/json

FieldTypeRequiredDescription

reasonstringOptionalRelease reason.

Request body (JSON)Reset to example

{ "reason": "YOUR_REASON" }

Send Request Clear all

When to use this endpoint

Use this endpoint to remove a single run from the Run Queue so it never executes. It does the same thing as the batch Release Run Queue Items endpoint, but takes the queue_ref directly in the URL — handy when you only have one item to release.

Path Parameters

Parameter	Required	Type	Description
queueId	Yes	string	The queue item ID. Copy this from the queue_ref returned by List Run Queue Items.

Request Body

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

Field	Required	Type	Description
reason	No	string	Optional reason for releasing, recorded for your later reference.

JSON Example

{
  "reason": "no longer needed"
}

Request Example

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

Response Example

{
  "code": 0,
  "data": {
    "results": [
      { "queue_ref": "123456", "success": true }
    ]
  },
  "message": "success",
  "request_id": "req-123"
}

Response Fields

Field	Type	Description
data.results[]	array	Per-item release outcome. The single item result mirrors the batch Release Run Queue Items response.
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.
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. To release several items at once, use the batch Release Run Queue Items endpoint.
• 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