Skip to content
Press.js Press.js Press.js Docs

Cancel a render job

POST
/v1/render-jobs/{jobId}/cancel
 
curl --request POST \
  --url https://api.presscloud.example/v1/render-jobs/example/cancel \
  --header 'Authorization: Bearer <token>'

Cancels a queued or retry-scheduled render job and returns its final state.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
jobId
required
string
>= 1 characters

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Canceled render job.

Media type application/json
object
job
required
object
id
required
string
>= 1 characters
deployId
required
string
deployVersionId
required
string
deployVersionNo
integer
deployVersionRoute
string
deployVersionTitle
string
businessKey
required
string
payloadHash
required
string
status
required
string
Allowed values: queued rendering succeeded retry_scheduled failed canceled
attempt
required
integer
requestedAt
required
integer
startedAt
integer
finishedAt
integer
errorCode
string
errorMessage
string
outputMode
required
string
Allowed values: transient managed
output
object
id
required
string
renderJobId
required
string
pdfBlobHash
string
pdfR2Key
string
bytes
required
integer
pageCount
integer
>= 1
timingJson
string
createdAt
required
integer
state
required
string
Allowed values: available deleted
accessGuaranteedUntil
integer
deleteAfter
integer
deleteReason
string
Allowed values: manual automatic_cleanup
deletedAt
integer
pdf
object
id
required
string
state
required
string
Allowed values: available deleting deleted
fileName
required
string
>= 1 characters
bytes
required
integer
pageCount
integer
>= 1
createdAt
required
integer
Example 
{
  "job": {
    "status": "queued",
    "outputMode": "transient"
  },
  "output": {
    "state": "available",
    "deleteReason": "manual"
  },
  "pdf": {
    "state": "available"
  }
}

404

Section titled “404 ”

Requested resource was not found.

Media type application/json
object
error
required
string
message
required
string
Example generated
{
  "error": "example",
  "message": "example"
}

409

Section titled “409 ”

Requested operation conflicts with the current resource state.

Media type application/json
object
error
required
string
message
required
string
Example generated
{
  "error": "example",
  "message": "example"
}