renders

Stop a render

Stop a render and get the time back. A render that has not started is cancelled at once; one that is running stops at its next checkpoint, so it can take up to a minute of work to notice. Either way the reservation is RELEASED and nothing is charged: cost.secondsCharged is 0 and the balance is whole. A render that has already finished, failed or been cancelled is 409 already_settled, and nothing changes.

post/renders/{id}/cancel

Request

  • Base URL: https://api.gogoscreen.com/api/v1
  • URL: https://api.gogoscreen.com/api/v1/renders/{id}/cancel
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring uuid required

The resource id, from a create answer or the matching list.

Headers

Idempotency-Keystring required

1–128 characters, unique to this request. A retry with the same key and the same body returns the STORED response with Idempotent-Replayed: true; the same key with a different body is 409 idempotency_conflict; a duplicate still in flight is 409 idempotency_in_progress. Claims expire after 24 hours.

Response

Stop a render

releasedboolean required

Whether a reservation was handed back. False for a render that held nothing.

removedFromQueueboolean required

Whether the render was cancelled before it started.

Changes

No recorded changes to this operation across all 1 revision of this API.