SCscanopy
Discoveries

Cancel discovery sessions

Changed on

Cancels the running session of each discovery, given discovery IDs. Sessions still queued are cancelled before running ones, so cancelling a running session never starts a queued one that is also being cancelled. The request is refused, and nothing is cancelled, if any discovery isn't running or its session is just starting on its daemon.

post/api/v1/discoveries/bulk-cancel

Request

  • Base URL
    https://app.scanopy.net
  • URL
    https://app.scanopy.net/api/v1/discoveries/bulk-cancel
  • Auth
    • API key in header Authorization
    • or API key in cookie session_id

Request body

string[] required

Response

Sessions cancelled

dataTupleUnit

No payload. Present only so the envelope keeps its shape.

errorstring nullable

Not sent on a successful response. Failure messages arrive in an ApiErrorResponse.

successboolean required

Always true on a successful response.

Example response

{
  "meta": {
    "api_version": 1,
    "server_version": "0.19.4"
  }
}

Changes