Skip to content
Nexa Platform Docs

Cancel statement

POST
/api/v1/statements/{statement_id}/cancel
curl --request POST \
  --url https://example.com/api/v1/statements/example/cancel

Cancel a SQL statement.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
statement_id
required
Statement Id

The ID of the statement to cancel

string

The ID of the statement to cancel

Header Parameters

Section titled “Header Parameters”
X-Environment-Id
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
StatementCancelResponse

Response model for statement cancellation.

object
statement_id
required
Statement Id

Statement ID that was cancelled

string
status
required
Status

Status after cancellation

string
message
required
Message

Cancellation result message

string
Examplegenerated
{
  "statement_id": "example",
  "status": "example",
  "message": "example"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}