List SQL warehouses

GET

/api/v1/warehouses/

curl --request GET \
  --url https://example.com/api/v1/warehouses/

List all SQL warehouses in the workspace.

Parameters

Header Parameters

X-Environment-Id

Any of:

string

string

null

null

Responses

200

Successful Response

Media typeapplication/json

WarehouseListResponse

Response model for listing warehouses.

object

warehouses

required

Warehouses

List of warehouses

Array<object>

WarehouseStatusResponse

Response model for warehouse status - backwards compatible.

object

id

required

Id

Warehouse ID

string

name

Any of:

string

string

null

null

state

required

State

Current warehouse state (RUNNING, STOPPED, etc.)

string

cluster_size

Any of:

string

string

null

null

min_num_clusters

Any of:

integer

integer

null

null

max_num_clusters

Any of:

integer

integer

null

null

auto_stop_mins

Any of:

integer

integer

null

null

creator_name

Any of:

string

string

null

null

jdbc_url

Any of:

string

string

null

null

odbc_params

Any of:

object

object

key

additional properties

any

null

null

num_clusters

Any of:

integer

integer

null

null

num_active_sessions

Any of:

integer

integer

null

null

tags

Any of:

object

object

key

additional properties

string

null

null

count

required

Count

Total number of warehouses

integer

Example^generated

{
  "warehouses": [
    {
      "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"
      }
    }
  ],
  "count": 1
}

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

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}