Discoveries

Start discovery session

Changed on
post/api/v1/discoveries/start-session

Request

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

Request body text/plain

string uuid required

Response

Discovery session started

errorstring nullable

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

successboolean required

Always true on a successful response.

Example response

{
  "data": {
    "warnings": [
      {
        "daemon_version": "0.18.0",
        "last_unsupported_daemon_version": "0.18.0"
      }
    ]
  },
  "meta": {
    "api_version": 1,
    "server_version": "0.19.4"
  }
}

Changes

    • breaking

      added subschema #56 to the // response property oneOf list for the response status

    • warning

      added the new DaemonDroppedSession enum value to the ///// response property for the response status

    • warning

      added the new DaemonOffline enum value to the ///// response property for the response status

    • warning

      added the new SessionSilent enum value to the ///// response property for the response status