Delete request

DELETE 
/v2/request-queues/:queueId/requests/:requestId

Deletes given request from queue.

Request

Path Parameters

queueId string required
Queue ID or username~queue-name.

Example: WkzbQMuFYuamGv3YF
requestId string required
Request ID.

Example: xpsmkDlspokDSmklS

Query Parameters

clientKey string
A unique identifier of the client accessing the request queue. It must be a string between 1 and 32 characters long. This identifier is used to determine whether the queue was accessed by multiple clients. If clientKey is not provided, the system considers this API call to come from a new client. For details, see the hadMultipleClients field returned by the Get head operation.

Example: client-abc

Status 204

Response Headers

Status 400

Bad request - invalid input parameters or request body.

{
  "error": {
    "type": "invalid-input",
    "message": "Invalid input: The request body contains invalid data."
  }
}

Schema

• error object required

  • type string required
    Example: run-failed
  • message string required
    Example: Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)

Status 401

Unauthorized - authentication required or invalid token.

{
  "error": {
    "type": "token-not-valid",
    "message": "Authentication token is not valid."
  }
}

Schema

• error object required

  • type string required
    Example: run-failed
  • message string required
    Example: Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)

Status 403

Forbidden - insufficient permissions to perform this action.

{
  "error": {
    "type": "permission-denied",
    "message": "You do not have permission to perform this action."
  }
}

Schema

• error object required

  • type string required
    Example: run-failed
  • message string required
    Example: Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)

Status 404

Not found - the requested resource was not found.

{
  "error": {
    "type": "record-not-found",
    "message": "Request Queue was not found"
  }
}

Schema

• error object

  • type string

    Possible values: [record-not-found]

  • message string
    Example: Request Queue was not found

Status 405

Method not allowed.

{
  "error": {
    "type": "method-not-allowed",
    "message": "This API end-point can only be accessed using the following HTTP methods: OPTIONS,GET"
  }
}

Schema

• error object required

  • type string required
    Example: run-failed
  • message string required
    Example: Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)

Status 429

Too many requests - rate limit exceeded.

{
  "error": {
    "type": "rate-limit-exceeded",
    "message": "You have exceeded the rate limit. Please try again later."
  }
}

Schema

• error object required

  • type string required
    Example: run-failed
  • message string required
    Example: Actor run did not succeed (run ID: 55uatRrZib4xbZs, status: FAILED)