query

Cancel an external query

Changed on

Stops an active canary query and retains only its terminal state.

delete/query/{request_id}

Request

  • Base URL
    https://developer.qaip.com/api/v1
  • URL
    https://developer.qaip.com/api/v1/query/{request_id}
  • Auth
    API key in header x-api-key

Path parameters

request_idstring uuid required

Response

Cancellation outcome or unchanged terminal state

response_type'state_only' required
request_idstring uuid required
state'RECEIVED' | 'PREPARING' | 'CACHE_READY' | 'RUNNING' | 'CANCELLING' | 'CANCELLED' | 'SUCCEEDED' | 'FAILED' | 'UNKNOWN' required
terminalboolean required
failure_class'invalid_request' | 'unauthorized' | 'snapshot_unavailable' | 'capacity' | 'build_timeout' | 'query_timeout' | 'rate_limited' | 'internal' nullable
retry_after_secondsinteger nullable

Changes

  • 2489c6f1a9d8Revision changes
    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • b065e544fec5Revision changes
    • info

      endpoint added