Snowflake Service API

The service API from Snowflake — 13 operation(s) for service.

Documentation GitHub OpenAPI

Operations 16

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v2/databases/{database}/schemas/{schema}/services List container services in a schema · List Services #

Ask an LLM

“Which Snowpark Container Services services are running in this schema?”

“Can I see every service defined under a database and schema?”

Tell an agent

List the container services in this schema.

Show me all services under the current database and schema.

POST /api/v2/databases/{database}/schemas/{schema}/services Create a container service · Create a Service #

Ask an LLM

“How do I deploy a long-running service on a compute pool from a spec?”

“Can I set minimum and maximum instances when creating a service?”

Tell an agent

Create service {name} on compute pool {compute_pool} using spec {spec}.

Create service {name} on {compute_pool} from {spec}, scaling between {min} and {max} instances.

POST /api/v2/databases/{database}/schemas/{schema}/services:execute-job Run a one-off job service · Execute a Job Service #

Ask an LLM

“How do I run a batch job in a container that exits when it's done?”

“Can I run a job service asynchronously instead of waiting for it to finish?”

Tell an agent

Execute job service {name} on compute pool {compute_pool} with spec {spec}.

Kick off job {name} on {compute_pool} from {spec} and don't wait for it (async {is_async}).

GET /api/v2/databases/{database}/schemas/{schema}/services/{name} Get the details of a service · Fetch service #

Ask an LLM

“What compute pool, instance counts and DNS name does a given service have?”

“Where do I read one container service's full definition?”

Tell an agent

Show me the definition of this service.

Fetch the named service's properties, including its owner and compute pool.

PUT /api/v2/databases/{database}/schemas/{schema}/services/{name} Create or update a service definition · Create a (or Alter an Existing) Service #

Ask an LLM

“Can I change a running service's spec by resubmitting its full property set?”

“Which call creates a service if missing or alters it when it already exists?”

Tell an agent

Create or alter service {name} on {compute_pool} to use spec {spec}.

Update service {name} so auto suspend happens after {secs} seconds, keeping pool {compute_pool} and spec {spec}.

DELETE /api/v2/databases/{database}/schemas/{schema}/services/{name} Delete a service · Delete a Service #

Ask an LLM

“How do I tear down a container service I no longer need?”

“Will dropping a service fail if it doesn't exist?”

Tell an agent destructive · confirm first

Delete this container service.

Drop the service permanently.

GET /api/v2/databases/{database}/schemas/{schema}/services/{name}/logs Read a service container's logs · Fetch service logs #

Ask an LLM

“How can I see the log output of a specific container in my service?”

“Can I limit how many log lines come back from a service container?”

Tell an agent

Get the logs for container {container} on instance {instance}.

Show the last {lines} log lines from container {container} on instance {instance}.

GET /api/v2/databases/{database}/schemas/{schema}/services/{name}/status Check a service's status · Fetch service status #

Ask an LLM

“Is my container service running, pending or failed right now?”

“Can I wait a few seconds for a service's status to settle before it returns?”

Tell an agent

Check the status of this service.

Get the service status, waiting up to {timeout} seconds.

GET /api/v2/databases/{database}/schemas/{schema}/services/{name}/containers List a service's containers · List service containers #

Ask an LLM

“Which containers make up this service?”

“Can I see each container of a service and its state?”

Tell an agent

List the containers in this service.

Show every container running for the service.

GET /api/v2/databases/{database}/schemas/{schema}/services/{name}/instances List a service's instances · List service instances #

Ask an LLM

“How many instances of my service are running?”

“Where can I see each instance of a container service?”

Tell an agent

List the instances of this service.

Show all running instances for the service.

GET /api/v2/databases/{database}/schemas/{schema}/services/{name}/roles List a service's service roles · List service roles #

Ask an LLM

“What service roles does this service define?”

“Which roles can be granted to control access to a service's endpoints?”

Tell an agent

List the service roles defined by this service.

Show me the service roles on the service.

GET /api/v2/databases/{database}/schemas/{schema}/services/{service}/roles/{name}/grants-of Show who holds a service role · List service role grants of #

Ask an LLM

“Which account roles or users have been granted a particular service role?”

“Who has been given this service role?”

Tell an agent

List who has been granted this service role on service {service}.

Show the grants of the service role from {service}.

GET /api/v2/databases/{database}/schemas/{schema}/services/{service}/roles/{name}/grants Show privileges granted to a service role · List service role grants to #

Ask an LLM

“What privileges does a service role carry, such as access to endpoints?”

“Which endpoints can a given service role reach?”

Tell an agent

List the privileges granted to this service role of {service}.

Show what the service role on {service} is allowed to do.

POST /api/v2/databases/{database}/schemas/{schema}/services/{name}:resume Resume a suspended service · Resume service #

Ask an LLM

“How do I restart a service I suspended earlier?”

“Can I bring a suspended container service back online?”

Tell an agent

Resume this service.

Start the suspended service back up.

POST /api/v2/databases/{database}/schemas/{schema}/services/{name}:suspend Suspend a running service · Suspend service #

Ask an LLM

“How do I pause a container service to stop it using compute?”

“Can I suspend a service without deleting it?”

Tell an agent

Suspend this service.

Pause the running service for now.

GET /api/v2/databases/{database}/schemas/{schema}/services/{name}/endpoints List a service's endpoints · List the Endpoints in a Service #

Ask an LLM

“What endpoints and ingress URLs does my service expose?”

“Which ports and protocols is a job or container service listening on?”

Tell an agent

List the endpoints this service exposes.

Show me the public ingress URLs for the service.

Snowflake Service API

Operations 16

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification