SCscanopy
Discoveries

Cancel discovery session

Changed on
post/api/v1/discoveries/{session_id}/cancel

Request

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

Path parameters

session_idstring uuid required

Session ID

Response

Discovery session 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