Warehouse

Create or replace warehouse¶

POST/api/v2/warehouses

Create a virtual warehouse. Equivalent to CREATE WAREHOUSE in SQL.

Query Parameters

Parameter	Type	Description
createMode	string	Query parameter allowing support for different modes of resource creation. Possible values include: errorIfExists: Throws an error if you try to create a resource that already exists. orReplace: Automatically replaces the existing resource with the current one. ifNotExists: Creates a new resource when an alter is requested for a non-existent resource.

Parameter	Type	Description

{
  "name": "TEST_NAME",
  "warehouse_type": "string",
  "warehouse_size": "string",
  "wait_for_completion": true,
  "max_cluster_count": 0,
  "min_cluster_count": 0,
  "scaling_policy": "string",
  "auto_suspend": 0,
  "auto_resume": true,
  "initially_suspended": true,
  "resource_monitor": "TEST_NAME",
  "comment": "string",
  "enable_query_acceleration": true,
  "query_acceleration_max_scale_factor": 0,
  "max_concurrency_level": 0,
  "statement_queued_timeout_in_seconds": 0,
  "statement_timeout_in_seconds": 0,
  "type": "string",
  "size": "string",
  "state": "string",
  "started_clusters": 0,
  "running": 0,
  "queued": 0,
  "is_default": true,
  "is_current": true,
  "available": "string",
  "provisioning": "string",
  "quiescing": "string",
  "other": "string",
  "created_on": "2019-08-24T14:15:22Z",
  "resumed_on": "2019-08-24T14:15:22Z",
  "updated_on": "2019-08-24T14:15:22Z",
  "owner": "string",
  "budget": "string",
  "kind": "string",
  "owner_role_type": "string"
}

Response

Code

Description

200

Successful request.

{
  "status": "Request successfully completed"
}

Name	Type
X-Snowflake-Request-ID

202

400
401
403
405
408
409
410
429
500
503
504

Parameter	Type	Description
status	string	Message returned by the server.

List warehouse¶

GET/api/v2/warehouses

Show a list of warehouse filtered by pattern. Equivalent to SHOW WAREHOUSE in SQL.

Query Parameters

Parameter	Type	Description
like	string	Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.

Response

Code

Description

200

successful

[
  {
    "name": "TEST_NAME",
    "warehouse_type": "string",
    "warehouse_size": "string",
    "wait_for_completion": true,
    "max_cluster_count": 0,
    "min_cluster_count": 0,
    "scaling_policy": "string",
    "auto_suspend": 0,
    "auto_resume": true,
    "initially_suspended": true,
    "resource_monitor": "TEST_NAME",
    "comment": "string",
    "enable_query_acceleration": true,
    "query_acceleration_max_scale_factor": 0,
    "max_concurrency_level": 0,
    "statement_queued_timeout_in_seconds": 0,
    "statement_timeout_in_seconds": 0,
    "type": "string",
    "size": "string",
    "state": "string",
    "started_clusters": 0,
    "running": 0,
    "queued": 0,
    "is_default": true,
    "is_current": true,
    "available": "string",
    "provisioning": "string",
    "quiescing": "string",
    "other": "string",
    "created_on": "2019-08-24T14:15:22Z",
    "resumed_on": "2019-08-24T14:15:22Z",
    "updated_on": "2019-08-24T14:15:22Z",
    "owner": "string",
    "budget": "string",
    "kind": "string",
    "owner_role_type": "string"
  }
]

Name	Type	Description
X-Snowflake-Request-ID	string	Unique ID of the API request.

202

Successfully accepted the request, but it is not completed yet.

{
  "code": "392604",
  "message": "Request execution in progress. Use the provided location header or result handler ID to perform query monitoring and management."
}

Name	Type	Description
Location	string	Relative path for checking request status or getting the result, if available.
X-Snowflake-Request-ID

400	Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct request payload. The response body may include the error code and message indicating the actual cause. The application must reconstruct the request body for retry.
401	Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response body may include the error code and message indicating the actual cause, e.g., expired, invalid token. The application must obtain a new access token for retry.
403	Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.
404	Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.
405	Method Not Allowed. The request method doesn't match the supported API. This happens, for example, if the application calls the API with GET method but the endpoint accepts only POST.
408	Request Timeout. This indicates that the request from the client timed out and was not completed by the server.
409	Conflict. The requested operation could not be performed due to a conflicting state that could not be resolved. This usually happens when a CREATE request was performed when there is a pre-existing resource with the same name, and also without one of the options orReplace/ifNotExists.
410	Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.
429	Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.
500	Internal Server Error. The server hit an unrecoverable system error. The response body may include the error code and message for further guidance. The application owner may need to reach out the customer support.
503	Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.
504	Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.

Parameter	Type	Description

Describe warehouse¶

GET/api/v2/warehouses/{name}

Describes the warehouse, show information of the chosen warehouse. Equivalent to DESCRIBE WAREHOUSE in SQL.

Path Parameters

Parameter	Type	Description
name		Identifier (i.e. name) for the resource.

Response

Code

Description

200

successful

{
  "name": "TEST_NAME",
  "warehouse_type": "string",
  "warehouse_size": "string",
  "wait_for_completion": true,
  "max_cluster_count": 0,
  "min_cluster_count": 0,
  "scaling_policy": "string",
  "auto_suspend": 0,
  "auto_resume": true,
  "initially_suspended": true,
  "resource_monitor": "TEST_NAME",
  "comment": "string",
  "enable_query_acceleration": true,
  "query_acceleration_max_scale_factor": 0,
  "max_concurrency_level": 0,
  "statement_queued_timeout_in_seconds": 0,
  "statement_timeout_in_seconds": 0,
  "type": "string",
  "size": "string",
  "state": "string",
  "started_clusters": 0,
  "running": 0,
  "queued": 0,
  "is_default": true,
  "is_current": true,
  "available": "string",
  "provisioning": "string",
  "quiescing": "string",
  "other": "string",
  "created_on": "2019-08-24T14:15:22Z",
  "resumed_on": "2019-08-24T14:15:22Z",
  "updated_on": "2019-08-24T14:15:22Z",
  "owner": "string",
  "budget": "string",
  "kind": "string",
  "owner_role_type": "string"
}

Name	Type
X-Snowflake-Request-ID

202

400
401
403
404
405
408
409
410
429
500
503
504

Parameter	Type	Description

Drop warehouse¶

DELETE/api/v2/warehouses/{name}

Removes the specified virtual warehouse from the system. Equivalent to DROP WAREHOUSE in SQL.

Query Parameters

Parameter	Type	Description
ifExists	boolean	Query parameter that specifies how to handle the request for a resource that does not exist: true: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource. false: The endpoint throws an error if the resource doesn't exist.

Response

Code	Description
200
202

400
401
403
404
405
408
409
410
429
500
503
504

Create a (or alter an existing) warehouse¶

PUT/api/v2/warehouses/{name}

Create a (or alter an existing) warehouse. Even if the operation is just an alter, the full property set must be provided.

Parameter	Type	Description

{
  "name": "TEST_NAME",
  "warehouse_type": "string",
  "warehouse_size": "string",
  "wait_for_completion": true,
  "max_cluster_count": 0,
  "min_cluster_count": 0,
  "scaling_policy": "string",
  "auto_suspend": 0,
  "auto_resume": true,
  "initially_suspended": true,
  "resource_monitor": "TEST_NAME",
  "comment": "string",
  "enable_query_acceleration": true,
  "query_acceleration_max_scale_factor": 0,
  "max_concurrency_level": 0,
  "statement_queued_timeout_in_seconds": 0,
  "statement_timeout_in_seconds": 0,
  "type": "string",
  "size": "string",
  "state": "string",
  "started_clusters": 0,
  "running": 0,
  "queued": 0,
  "is_default": true,
  "is_current": true,
  "available": "string",
  "provisioning": "string",
  "quiescing": "string",
  "other": "string",
  "created_on": "2019-08-24T14:15:22Z",
  "resumed_on": "2019-08-24T14:15:22Z",
  "updated_on": "2019-08-24T14:15:22Z",
  "owner": "string",
  "budget": "string",
  "kind": "string",
  "owner_role_type": "string"
}

Response

Code	Description
200
202

400
401
403
404
405
408
409
410
429
500
503
504

resume warehouse¶

POST/api/v2/warehouses/{name}:resume

Bring current warehouse to a usable ‘Running’ state by provisioning compute resources if current warehouse is suspended.

Response

Code	Description
200
202

400
401
403
404
405
408
409
410
429
500
503
504

suspend warehouse¶

POST/api/v2/warehouses/{name}:suspend

Remove all compute nodes from a warehouse and put the warehouse into a ‘Suspended’ state if current warehouse is not suspended.

Response

Code	Description
200
202

400
401
403
404
405
408
409
410
429
500
503
504

update and rename warehouse¶

POST/api/v2/warehouses/{name}:rename

Specifies a new identifier for the warehouse; must be unique for current account.

Parameter	Type	Description

{
  "name": "TEST_NAME",
  "warehouse_type": "string",
  "warehouse_size": "string",
  "wait_for_completion": true,
  "max_cluster_count": 0,
  "min_cluster_count": 0,
  "scaling_policy": "string",
  "auto_suspend": 0,
  "auto_resume": true,
  "initially_suspended": true,
  "resource_monitor": "TEST_NAME",
  "comment": "string",
  "enable_query_acceleration": true,
  "query_acceleration_max_scale_factor": 0,
  "max_concurrency_level": 0,
  "statement_queued_timeout_in_seconds": 0,
  "statement_timeout_in_seconds": 0,
  "type": "string",
  "size": "string",
  "state": "string",
  "started_clusters": 0,
  "running": 0,
  "queued": 0,
  "is_default": true,
  "is_current": true,
  "available": "string",
  "provisioning": "string",
  "quiescing": "string",
  "other": "string",
  "created_on": "2019-08-24T14:15:22Z",
  "resumed_on": "2019-08-24T14:15:22Z",
  "updated_on": "2019-08-24T14:15:22Z",
  "owner": "string",
  "budget": "string",
  "kind": "string",
  "owner_role_type": "string"
}

Response

Code	Description
200
202

400
401
403
404
405
408
409
410
429
500
503
504

abort all queries¶

POST/api/v2/warehouses/{name}:abort

Aborts all the queries currently running or queued on the warehouse.

Response

Code	Description
200
202

400
401
403
404
405
408
409
410
429
500
503
504

use current warehouse for session (Deprecated)¶

POST/api/v2/warehouses/{name}:use

[Deprecated] Specifies the active/current warehouse for the session.

Response

Code	Description
200
202

400
401
403
404
405
408
409
410
429
500
503
504

Warehouse

Create or replace warehouse¶

Query Parameters

Body Parameters

Request Example

Response

Response Body Schema

List warehouse¶

Query Parameters

Response

Response Body Schema

Describe warehouse¶

Path Parameters

Response

Response Body Schema

Drop warehouse¶

Query Parameters

Response

Create a (or alter an existing) warehouse¶

Body Parameters

Request Example

Response

resume warehouse¶

Response

suspend warehouse¶

Response

update and rename warehouse¶

Body Parameters

Request Example

Response

abort all queries¶

Response

use current warehouse for session (Deprecated)¶

Response