List Warehouses

GET

/api/v1/warehouses

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

List all warehouses.

Returns: WarehouseListResponse with list of warehouses

Raises: HTTPException: If listing warehouses fails

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>

WarehouseInfo

Warehouse information model.

object

name

required

Name

Warehouse name

string

state

required

State

Warehouse state (STARTED, SUSPENDED, RESIZING)

string

type

required

Type

Warehouse type (STANDARD, SNOWPARK-OPTIMIZED)

string

size

required

Size

Warehouse size (X-SMALL, SMALL, MEDIUM, etc.)

string

min_cluster_count

required

Min Cluster Count

Minimum number of clusters

integer

max_cluster_count

required

Max Cluster Count

Maximum number of clusters

integer

started_clusters

required

Started Clusters

Number of currently running clusters

integer

running

required

Running

Number of running queries

integer

queued

required

Queued

Number of queued queries

integer

is_default

Is Default

Whether this is the default warehouse

boolean

is_current

Is Current

Whether this is the current warehouse

boolean

auto_suspend

Any of:

integer

integer

null

null

auto_resume

Auto Resume

Whether auto-resume is enabled

boolean

default: true

available

Any of:

number

number

null

null

provisioning

Any of:

number

number

null

null

quiescing

Any of:

number

number

null

null

other

Any of:

number

number

null

null

created_on

Any of:

string

string format: date-time

null

null

resumed_on

Any of:

string

string format: date-time

null

null

updated_on

Any of:

string

string format: date-time

null

null

owner

Any of:

string

string

null

null

comment

Any of:

string

string

null

null

resource_monitor

Any of:

string

string

null

null

actives

Actives

Number of active queries

integer

0

pendings

Pendings

Number of pending queries

integer

0

failed

Failed

Number of failed queries

integer

0

suspended

Suspended

Number of suspended queries

integer

0

uuid

Any of:

string

string

null

null

total_count

required

Total Count

Total number of warehouses

integer

Example

{
  "warehouses": [
    {
      "is_default": false,
      "is_current": false,
      "auto_resume": true,
      "actives": 0,
      "pendings": 0,
      "failed": 0,
      "suspended": 0
    }
  ]
}

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