Skip to content
Nexa Platform Docs

Get warehouse status

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

Get the current status of 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
WarehouseStatusResponse

Response model for warehouse status - backwards compatible.

object
id
required
Id

Warehouse ID

string
name
Any of:
string
state
required
State

Current warehouse state (RUNNING, STOPPED, etc.)

string
cluster_size
Any of:
string
min_num_clusters
Any of:
integer
max_num_clusters
Any of:
integer
auto_stop_mins
Any of:
integer
creator_name
Any of:
string
jdbc_url
Any of:
string
odbc_params
Any of:
object
key
additional properties
any
num_clusters
Any of:
integer
num_active_sessions
Any of:
integer
tags
Any of:
object
key
additional properties
string
Examplegenerated
{
  "id": "example",
  "name": "example",
  "state": "example",
  "cluster_size": "example",
  "min_num_clusters": 1,
  "max_num_clusters": 1,
  "auto_stop_mins": 1,
  "creator_name": "example",
  "jdbc_url": "example",
  "odbc_params": {},
  "num_clusters": 1,
  "num_active_sessions": 1,
  "tags": {
    "additionalProperty": "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"
    }
  ]
}