Skip to content
Nexa Platform Docs

Stop SQL warehouse

POST
/api/v1/warehouses/{warehouse_id}/stop
curl --request POST \
  --url https://example.com/api/v1/warehouses/example/stop

Stop a SQL warehouse.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
warehouse_id
required
Warehouse Id

The ID of the warehouse

string

The ID of the warehouse

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
WarehouseOperationResponse

Response model for warehouse operations.

object
status
required
Status

Operation status (success, error, timeout)

string
message
required
Message

Status message

string
warehouse_id
required
Warehouse Id

Warehouse ID

string
state
Any of:
string
startup_time_seconds
Any of:
number
Examplegenerated
{
  "status": "example",
  "message": "example",
  "warehouse_id": "example",
  "state": "example",
  "startup_time_seconds": 1
}

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"
    }
  ]
}