marketing

Stop a scan

Stop whatever scan of this source is queued or running. The source itself stays: if it had already published a manifest it goes back to succeeded with that manifest current, and if it had not it is failed. Answers how many scan attempts were stopped — zero is not an error, it means nothing was running.

post/marketing/sources/{id}/cancel

Request

  • Base URL: https://api.gogoscreen.com/api/v1
  • URL: https://api.gogoscreen.com/api/v1/marketing/sources/{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 scan

cancellednumber required
resourceobject required

Changes

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