Snowflake

Snowflake compute-pool API

The compute-pool API from Snowflake — 6 operation(s) for compute-pool.

Documentation GitHub OpenAPI

Operations 13

GET /api/v2/compute-pools Lists Compute Pools. #

POST /api/v2/compute-pools Creates a Compute Pool. #

GET /api/v2/compute-pools/{name} Fetches a Compute Pool. #

PUT /api/v2/compute-pools/{name} Create a (or Alter an Existing) Compute Pool. #

DELETE /api/v2/compute-pools/{name} Deletes a Compute Pool. #

POST /api/v2/compute-pools/{name}:resume Resumes a Suspended Compute Pool. #

POST /api/v2/compute-pools/{name}:suspend Suspends an Active Compute Pool. #

POST /api/v2/compute-pools/{name}:stopallservices Stops All Services on the Compute Pool. #

POST /api/v2/compute-pools/{name}:stop-all-services Stops All Services on the Compute Pool. #

GET /api/v2/compute-pools/instance-families Lists available compute pool instance families. #

POST /api/v2/compute-pools/{name}:set-tags Set tags on a compute pool. #

POST /api/v2/compute-pools/{name}:unset-tags Unset tags from a compute pool. #

GET /api/v2/compute-pools/{name}:get-tags Get the tag assignments for a compute pool. #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/snowflake-compute-pool-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Snowflake Compute Pool API
  version: 0.0.1
  contact:
    name: Snowflake, Inc.
    url: https://snowflake.com
    email: support@snowflake.com
  description: 'Operations tagged compute-pool across 2 of this provider''s published API definitions: compute-pool.yaml, compute-pool.yaml. Each path carries the servers of the definition it was published in.'
servers:
- description: Snowflake Compute Pools API
  url: https://org-account.snowflakecomputing.com
tags:
- name: compute-pool
paths:
  /api/v2/compute-pools:
    get:
      summary: Lists Compute Pools.
      tags:
      - compute-pool
      description: Lists the compute pools under the account.
      operationId: listComputePools
      parameters:
      - $ref: common.yaml#/components/parameters/like
      - $ref: common.yaml#/components/parameters/startsWith
      - $ref: common.yaml#/components/parameters/showLimit
      responses:
        '200':
          description: Successful request.
          headers:
            X-Snowflake-Request-ID:
              $ref: common.yaml#/components/headers/X-Snowflake-Request-ID
            Link:
              $ref: common.yaml#/components/headers/Link
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ComputePool'
              examples:
                Listcomputepools200Example:
                  summary: Default listComputePools 200 response
                  x-microcks-default: true
                  value:
                  - name: {}
                    min_nodes: 10
                    max_nodes: 10
                    instance_family: example_value
                    auto_resume: true
                    comment: example_value
                    state: UNKNOWN
                    num_services: 10
                    num_jobs: 10
                    auto_suspend_secs: 10
                    active_nodes: 10
                    idle_nodes: 10
                    target_nodes: 10
                    created_on: '2026-01-15T10:30:00Z'
                    resumed_on: '2026-01-15T10:30:00Z'
                    updated_on: '2026-01-15T10:30:00Z'
                    owner: example_value
                    is_exclusive: true
                    application: example_value
                    budget: example_value
                    error_code: example_value
                    status_message: example_value
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - KeyPair: []
      - ExternalOAuth: []
      - SnowflakeOAuth: []
    post:
      summary: Creates a Compute Pool.
      tags:
      - compute-pool
      description: Creates a compute pool, with standard create modifiers as query parameters. See the Compute Pool component definition for what is required to be provided in the request body.
      operationId: createComputePool
      parameters:
      - $ref: common.yaml#/components/parameters/createMode
      - name: initiallySuspended
        in: query
        description: Specifies whether the compute pool is created initially in the suspended state.
        schema:
          type: boolean
        example: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComputePool'
            examples:
              CreatecomputepoolRequestExample:
                summary: Default createComputePool request
                x-microcks-default: true
                value:
                  name: {}
                  min_nodes: 10
                  max_nodes: 10
                  instance_family: example_value
                  auto_resume: true
                  comment: example_value
                  state: UNKNOWN
                  num_services: 10
                  num_jobs: 10
                  auto_suspend_secs: 10
                  active_nodes: 10
                  idle_nodes: 10
                  target_nodes: 10
                  created_on: '2026-01-15T10:30:00Z'
                  resumed_on: '2026-01-15T10:30:00Z'
                  updated_on: '2026-01-15T10:30:00Z'
                  owner: example_value
                  is_exclusive: true
                  application: example_value
                  budget: example_value
                  error_code: example_value
                  status_message: example_value
      responses:
        '200':
          $ref: common.yaml#/components/responses/200SuccessResponse
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '408':
          $ref: common.yaml#/components/responses/408RequestTimeout
        '409':
          $ref: common.yaml#/components/responses/409Conflict
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - KeyPair: []
      - ExternalOAuth: []
      - SnowflakeOAuth: []
    servers:
    - description: Snowflake Compute Pools API
      url: https://org-account.snowflakecomputing.com
  /api/v2/compute-pools/{name}:
    get:
      summary: Fetches a Compute Pool.
      tags:
      - compute-pool
      description: Fetches a named compute pool. You can get the name of the compute pool from the `/api/v2/compute-pools` GET request.
      operationId: fetchComputePool
      parameters:
      - $ref: common.yaml#/components/parameters/name
      responses:
        '200':
          description: Successful request.
          headers:
            X-Snowflake-Request-ID:
              $ref: common.yaml#/components/headers/X-Snowflake-Request-ID
            Link:
              $ref: common.yaml#/components/headers/Link
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComputePool'
              examples:
                Fetchcomputepool200Example:
                  summary: Default fetchComputePool 200 response
                  x-microcks-default: true
                  value:
                    name: {}
                    min_nodes: 10
                    max_nodes: 10
                    instance_family: example_value
                    auto_resume: true
                    comment: example_value
                    state: UNKNOWN
                    num_services: 10
                    num_jobs: 10
                    auto_suspend_secs: 10
                    active_nodes: 10
                    idle_nodes: 10
                    target_nodes: 10
                    created_on: '2026-01-15T10:30:00Z'
                    resumed_on: '2026-01-15T10:30:00Z'
                    updated_on: '2026-01-15T10:30:00Z'
                    owner: example_value
                    is_exclusive: true
                    application: example_value
                    budget: example_value
                    error_code: example_value
                    status_message: example_value
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - KeyPair: []
      - ExternalOAuth: []
      - SnowflakeOAuth: []
    put:
      summary: Create a (or Alter an Existing) Compute Pool.
      tags:
      - compute-pool
      description: Create a (or alter an existing) compute pool. Even if the operation is just an alter, the full property set must be provided.
      operationId: createOrAlterComputePool
      parameters:
      - $ref: common.yaml#/components/parameters/name
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComputePool'
            examples:
              CreateoraltercomputepoolRequestExample:
                summary: Default createOrAlterComputePool request
                x-microcks-default: true
                value:
                  name: {}
                  min_nodes: 10
                  max_nodes: 10
                  instance_family: example_value
                  auto_resume: true
                  comment: example_value
                  state: UNKNOWN
                  num_services: 10
                  num_jobs: 10
                  auto_suspend_secs: 10
                  active_nodes: 10
                  idle_nodes: 10
                  target_nodes: 10
                  created_on: '2026-01-15T10:30:00Z'
                  resumed_on: '2026-01-15T10:30:00Z'
                  updated_on: '2026-01-15T10:30:00Z'
                  owner: example_value
                  is_exclusive: true
                  application: example_value
                  budget: example_value
                  error_code: example_value
                  status_message: example_value
      responses:
        '200':
          $ref: common.yaml#/components/responses/200SuccessResponse
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - KeyPair: []
      - ExternalOAuth: []
      - SnowflakeOAuth: []
    delete:
      parameters:
      - $ref: common.yaml#/components/parameters/name
      - $ref: common.yaml#/components/parameters/ifExists
      summary: Deletes a Compute Pool.
      tags:
      - compute-pool
      description: Deletes a compute pool with the given name. If you enable the `ifExists` parameter, the operation succeeds even if the object does not exist. Otherwise, a 404 failure is returned if the object does not exist.
      operationId: deleteComputePool
      responses:
        '200':
          $ref: common.yaml#/components/responses/200SuccessResponse
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - KeyPair: []
      - ExternalOAuth: []
      - SnowflakeOAuth: []
    servers:
    - description: Snowflake Compute Pools API
      url: https://org-account.snowflakecomputing.com
  /api/v2/compute-pools/{name}:resume:
    post:
      summary: Resumes a Suspended Compute Pool.
      tags:
      - compute-pool
      description: Resume a compute pool, if suspended. If the specified compute pool is already running, this will cause a 400 Bad Request error.
      operationId: resumeComputePool
      parameters:
      - $ref: common.yaml#/components/parameters/name
      responses:
        '200':
          $ref: common.yaml#/components/responses/200SuccessResponse
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - KeyPair: []
      - ExternalOAuth: []
      - SnowflakeOAuth: []
    servers:
    - description: Snowflake Compute Pools API
      url: https://org-account.snowflakecomputing.com
  /api/v2/compute-pools/{name}:suspend:
    post:
      summary: Suspends an Active Compute Pool.
      tags:
      - compute-pool
      description: Suspend a compute pool, if active. If the specified compute pool is already suspended, no action is taken.
      operationId: suspendComputePool
      parameters:
      - $ref: common.yaml#/components/parameters/name
      responses:
        '200':
          $ref: common.yaml#/components/responses/200SuccessResponse
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - KeyPair: []
      - ExternalOAuth: []
      - SnowflakeOAuth: []
    servers:
    - description: Snowflake Compute Pools API
      url: https://org-account.snowflakecomputing.com
  /api/v2/compute-pools/{name}:stopallservices:
    post:
      deprecated: true
      summary: Stops All Services on the Compute Pool.
      tags:
      - compute-pool
      description: Stops all services in the compute pool. Deprecated - use :stop-all-services instead.
      operationId: stopAllServicesInComputePoolDeprecated
      parameters:
      - $ref: common.yaml#/components/parameters/name
      responses:
        '200':
          $ref: common.yaml#/components/responses/200SuccessResponse
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - KeyPair: []
      - ExternalOAuth: []
      - SnowflakeOAuth: []
    servers:
    - description: Snowflake Compute Pools API
      url: https://org-account.snowflakecomputing.com
  /api/v2/compute-pools/{name}:stop-all-services:
    post:
      summary: Stops All Services on the Compute Pool.
      tags:
      - compute-pool
      description: Stops all services in the compute pool.
      operationId: stopAllServicesInComputePool
      parameters:
      - $ref: common.yaml#/components/parameters/name
      responses:
        '200':
          $ref: common.yaml#/components/responses/200SuccessResponse
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      security:
      - KeyPair: []
      - ExternalOAuth: []
      - SnowflakeOAuth: []
    servers:
    - description: Snowflake Compute Pools API
      url: https://org-account.snowflakecomputing.com
  /api/v2/compute-pools/instance-families:
    get:
      summary: Lists available compute pool instance families.
      tags:
      - compute-pool
      description: Lists all available instance families that can be used when creating compute pools.
      operationId: listComputePoolInstanceFamilies
      responses:
        '200':
          description: Successful request.
          headers:
            X-Snowflake-Request-ID:
              $ref: common.yaml#/components/headers/X-Snowflake-Request-ID
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ComputePoolInstanceFamily'
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
      security:
      - KeyPair: []
      - ExternalOAuth: []
      - SnowflakeOAuth: []
      - ProgrammaticAccessToken: []
    servers:
    - description: Snowflake Compute Pools API
      url: https://org-account.snowflakecomputing.com
  /api/v2/compute-pools/{name}:set-tags:
    post:
      summary: Set tags on a compute pool.
      tags:
      - compute-pool
      description: Set tags on a compute pool.
      operationId: setTags
      parameters:
      - $ref: common.yaml#/components/parameters/name
      - $ref: common.yaml#/components/parameters/ifExists
      responses:
        '200':
          $ref: common.yaml#/components/responses/200SuccessResponse
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '408':
          $ref: common.yaml#/components/responses/408RequestTimeout
        '409':
          $ref: common.yaml#/components/responses/409Conflict
        '410':
          $ref: common.yaml#/components/responses/410Gone
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: common.yaml#/components/schemas/TagAssignment
      security:
      - KeyPair: []
      - ExternalOAuth: []
      - SnowflakeOAuth: []
      - ProgrammaticAccessToken: []
    servers:
    - description: Snowflake Compute Pools API
      url: https://org-account.snowflakecomputing.com
  /api/v2/compute-pools/{name}:unset-tags:
    post:
      summary: Unset tags from a compute pool.
      tags:
      - compute-pool
      description: Unset tags from a compute pool.
      operationId: unsetTags
      parameters:
      - $ref: common.yaml#/components/parameters/name
      - $ref: common.yaml#/components/parameters/ifExists
      responses:
        '200':
          $ref: common.yaml#/components/responses/200SuccessResponse
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '408':
          $ref: common.yaml#/components/responses/408RequestTimeout
        '409':
          $ref: common.yaml#/components/responses/409Conflict
        '410':
          $ref: common.yaml#/components/responses/410Gone
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: common.yaml#/components/schemas/TagReference
      security:
      - KeyPair: []
      - ExternalOAuth: []
      - SnowflakeOAuth: []
      - ProgrammaticAccessToken: []
    servers:
    - description: Snowflake Compute Pools API
      url: https://org-account.snowflakecomputing.com
  /api/v2/compute-pools/{name}:get-tags:
    get:
      summary: Get the tag assignments for a compute pool.
      tags:
      - compute-pool
      description: Returns all tags assigned to a compute pool. This operation requires an active warehouse.
      operationId: getTags
      parameters:
      - $ref: common.yaml#/components/parameters/name
      - $ref: common.yaml#/components/parameters/withLineage
      responses:
        '200':
          description: successful
          headers:
            X-Snowflake-Request-ID:
              $ref: common.yaml#/components/headers/X-Snowflake-Request-ID
            Link:
              $ref: common.yaml#/components/headers/Link
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: common.yaml#/components/schemas/TagAssignment
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '408':
          $ref: common.yaml#/components/responses/408RequestTimeout
        '409':
          $ref: common.yaml#/components/responses/409Conflict
        '410':
          $ref: common.yaml#/components/responses/410Gone
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
      security:
      - KeyPair: []
      - ExternalOAuth: []
      - SnowflakeOAuth: []
      - ProgrammaticAccessToken: []
    servers:
    - description: Snowflake Compute Pools API
      url: https://org-account.snowflakecomputing.com
components:
  schemas:
    ComputePool:
      type: object
      description: A Snowflake compute pool definition.
      properties:
        name:
          $ref: ./common.yaml#/components/schemas/Identifier
        min_nodes:
          type: integer
          description: Minimum number of nodes for the compute pool.
          example: 10
        max_nodes:
          type: integer
          description: Maximum number of nodes for the compute pool.
          example: 10
        instance_family:
          type: string
          description: Instance family for the compute pool.
          example: example_value
        auto_resume:
          type: boolean
          description: Whether Snowflake automatically resumes the compute pool when any statement that requires the compute pool is submitted.
          example: true
        comment:
          type: string
          description: Comment describing the compute pool.
          example: example_value
        state:
          type: string
          description: Current state of the compute pool. Possible values include UNKNOWN, STARTING, IDLE, ACTIVE, STOPPING, SUSPENDED, and RESIZING.
          readOnly: true
          enum:
          - UNKNOWN
          - STARTING
          - IDLE
          - ACTIVE
          - STOPPING
          - SUSPENDED
          - RESIZING
          example: UNKNOWN
        num_services:
          type: integer
          description: Number of services on the compute pool.
          readOnly: true
          example: 10
        num_jobs:
          type: integer
          description: Number of jobs on the compute pool.
          readOnly: true
          example: 10
        auto_suspend_secs:
          type: integer
          description: Number of seconds until the compute pool automatically suspends.
          format: int64
          example: 10
        active_nodes:
          type: integer
          description: Number of currently active nodes on the compute pool.
          readOnly: true
          example: 10
        idle_nodes:
          type: integer
          description: Number of currently idle nodes on the compute pool.
          readOnly: true
          example: 10
        target_nodes:
          type: integer
          description: Number of target nodes on the compute pool.
          readOnly: true
          example: 10
        created_on:
          type: string
          description: Time the compute pool was created.
          format: date-time
          readOnly: true
          example: '2026-01-15T10:30:00Z'
        resumed_on:
          type: string
          description: Time the compute pool was last resumed.
          format: date-time
          readOnly: true
          example: '2026-01-15T10:30:00Z'
        updated_on:
          type: string
          description: Time the compute pool was last updated.
          format: date-time
          readOnly: true
          example: '2026-01-15T10:30:00Z'
        owner:
          type: string
          description: Identifier for the current owner of the compute pool.
          readOnly: true
          example: example_value
        is_exclusive:
          type: boolean
          description: Whether a compute pool is created exclusively for a Snowflake Native App.
          readOnly: true
          example: true
        application:
          type: string
          description: Name of the Snowflake Native App if the compute pool is created exclusively for the app.
          readOnly: true
          example: example_value
        budget:
          type: string
          description: The name of the budget monitoring the credit usage of the compute pool.
          readOnly: true
          example: example_value
        error_code:
          type: string
          description: Current error the compute pool hit if any.
          readOnly: true
          example: example_value
        status_message:
          type: string
          description: Current status of the compute pool if any.
          readOnly: true
          example: example_value
      example:
        name: compute_pool_name
        warehouse: test_wh
        min_nodes: 4
        max_nodes: 5
        instance_family: compute_pool_family
        auto_resume: false
        comment: test_comment
        state: STARTING
        num_services: 1
        num_jobs: 3
        auto_suspend_secs: 10
        active_nodes: 2
        idle_nodes: 2
        target_nodes: 4
        created_on: '2024-06-18T01:01:01.111111'
        updated_on: '2024-06-18T01:01:01.111111'
        resumed_on: '2024-06-18T01:01:01.111111'
        owner: POOL_ADMIN
        is_exclusive: true
        application: testapp
        budget: testbudget
   

# --- truncated at 32 KB (39 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/snowflake/refs/heads/main/openapi/snowflake-compute-pool-api-openapi.yml

Snowflake compute-pool API

Operations 13

Documentation

Specifications

Schemas & Data

Other Resources