Cancel Sql Query

POST/api/v2/sqlQueries/{sqlQueryId}/cancel

Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Cancels a query. If the query is no longer running this is effectively a no-op.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:sql-queries-execute.

Path parameters

sqlQueryId

string

The id of a query.

Query parameters

preview

boolean

optional

Enables the use of preview functionality.

Examples

Request

Copied!

curl -X POST \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/sqlQueries/OikKBfqBaWRjOGQ3YTJkNzMtYjhiZi00ZDMzLTlkOWMtOGQzOW/cancel?preview=true"

Error responses

Error Name
`QueryPermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	The provided token does not have permission to access the given query.
	Parameters	`queryId`
`QueryCanceled`	Error Code	`INVALID_ARGUMENT`
	Status Code	400
	Description	The query was canceled.
	Parameters	`queryId`
`QueryFailed`	Error Code	`INTERNAL`
	Status Code	500
	Description	The query failed.
	Parameters	`queryId, errorMessage`
`QueryParseError`	Error Code	`INVALID_ARGUMENT`
	Status Code	400
	Description	The query cannot be parsed.
	Parameters	`errorMessage`
`QueryRunning`	Error Code	`INVALID_ARGUMENT`
	Status Code	400
	Description	The query is running.
	Parameters	`queryId`
`ReadQueryInputsPermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	The provided token does not have permission to access the inputs to the query.
	Parameters	`rids`
`CancelSqlQueryPermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	Could not cancel the SqlQuery.
	Parameters	`sqlQueryId`

See Errors for a general overview of errors in the platform.