{ "info": { "_postman_id": "7b42e4e0-debe-4d74-a707-0a48f573448e", "name": "Snowflake Services API", "description": "The Snowflake Services API is a REST API that you can use to access, update, and perform certain actions on Services resource in a Snowflake database.\n\nContact Support:\n Name: Snowflake, Inc.\n Email: support@snowflake.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "53314882", "_collection_link": "https://go.postman.co/collection/53314882-7b42e4e0-debe-4d74-a707-0a48f573448e?source=collection_link" }, "item": [ { "name": "api", "item": [ { "name": "v2", "item": [ { "name": "databases", "item": [ { "name": "{database}", "item": [ { "name": "schemas", "item": [ { "name": "{schema}", "item": [ { "name": "services", "item": [ { "name": "{name}", "item": [ { "name": "logs", "item": [ { "name": "fetch Service Logs", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/logs?instanceId=1864&containerName=string&numLines=1864", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "logs" ], "query": [ { "description": "ID of the service instance, starting with 0.", "key": "instanceId", "value": "1864" }, { "description": "Container name as specified in the service specification file.", "key": "containerName", "value": "string" }, { "description": "Number of trailing log lines to retrieve.", "key": "numLines", "value": "1864" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] }, "description": "Fetch the logs for a given service." }, "response": [ { "name": "successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/logs?instanceId=1864&containerName=string&numLines=1864", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "logs" ], "query": [ { "description": "ID of the service instance, starting with 0.", "key": "instanceId", "value": "1864" }, { "description": "Container name as specified in the service specification file.", "key": "containerName", "value": "string" }, { "description": "Number of trailing log lines to retrieve.", "key": "numLines", "value": "1864" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Link", "value": "" } ], "cookie": [], "body": "{\n \"system$get_service_logs\": \"string\"\n}" }, { "name": "Successfully accepted the request, but it is not completed yet.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/logs?instanceId=1864&containerName=string&numLines=1864", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "logs" ], "query": [ { "description": "ID of the service instance, starting with 0.", "key": "instanceId", "value": "1864" }, { "description": "Container name as specified in the service specification file.", "key": "containerName", "value": "string" }, { "description": "Number of trailing log lines to retrieve.", "key": "numLines", "value": "1864" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Location", "value": "string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"code\": \"392604\",\n \"message\": \"Request execution in progress. Use the provided location header or result handler ID to perform query monitoring and management.\"\n}" }, { "name": "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 r", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/logs?instanceId=1864&containerName=string&numLines=1864", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "logs" ], "query": [ { "description": "ID of the service instance, starting with 0.", "key": "instanceId", "value": "1864" }, { "description": "Container name as specified in the service specification file.", "key": "containerName", "value": "string" }, { "description": "Number of trailing log lines to retrieve.", "key": "numLines", "value": "1864" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/logs?instanceId=1864&containerName=string&numLines=1864", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "logs" ], "query": [ { "description": "ID of the service instance, starting with 0.", "key": "instanceId", "value": "1864" }, { "description": "Container name as specified in the service specification file.", "key": "containerName", "value": "string" }, { "description": "Number of trailing log lines to retrieve.", "key": "numLines", "value": "1864" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/logs?instanceId=1864&containerName=string&numLines=1864", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "logs" ], "query": [ { "description": "ID of the service instance, starting with 0.", "key": "instanceId", "value": "1864" }, { "description": "Container name as specified in the service specification file.", "key": "containerName", "value": "string" }, { "description": "Number of trailing log lines to retrieve.", "key": "numLines", "value": "1864" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/logs?instanceId=1864&containerName=string&numLines=1864", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "logs" ], "query": [ { "description": "ID of the service instance, starting with 0.", "key": "instanceId", "value": "1864" }, { "description": "Container name as specified in the service specification file.", "key": "containerName", "value": "string" }, { "description": "Number of trailing log lines to retrieve.", "key": "numLines", "value": "1864" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/logs?instanceId=1864&containerName=string&numLines=1864", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "logs" ], "query": [ { "description": "ID of the service instance, starting with 0.", "key": "instanceId", "value": "1864" }, { "description": "Container name as specified in the service specification file.", "key": "containerName", "value": "string" }, { "description": "Number of trailing log lines to retrieve.", "key": "numLines", "value": "1864" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/logs?instanceId=1864&containerName=string&numLines=1864", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "logs" ], "query": [ { "description": "ID of the service instance, starting with 0.", "key": "instanceId", "value": "1864" }, { "description": "Container name as specified in the service specification file.", "key": "containerName", "value": "string" }, { "description": "Number of trailing log lines to retrieve.", "key": "numLines", "value": "1864" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/logs?instanceId=1864&containerName=string&numLines=1864", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "logs" ], "query": [ { "description": "ID of the service instance, starting with 0.", "key": "instanceId", "value": "1864" }, { "description": "Container name as specified in the service specification file.", "key": "containerName", "value": "string" }, { "description": "Number of trailing log lines to retrieve.", "key": "numLines", "value": "1864" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/logs?instanceId=1864&containerName=string&numLines=1864", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "logs" ], "query": [ { "description": "ID of the service instance, starting with 0.", "key": "instanceId", "value": "1864" }, { "description": "Container name as specified in the service specification file.", "key": "containerName", "value": "string" }, { "description": "Number of trailing log lines to retrieve.", "key": "numLines", "value": "1864" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/logs?instanceId=1864&containerName=string&numLines=1864", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "logs" ], "query": [ { "description": "ID of the service instance, starting with 0.", "key": "instanceId", "value": "1864" }, { "description": "Container name as specified in the service specification file.", "key": "containerName", "value": "string" }, { "description": "Number of trailing log lines to retrieve.", "key": "numLines", "value": "1864" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Gateway Timeout", "code": 504, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" } ] } ] }, { "name": "status", "item": [ { "name": "fetch Service Status", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/status?timeout=1864", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "status" ], "query": [ { "description": "Number of seconds to wait for the service to reach a steady state (for example, READY) before returning the status. If the service does not reach a steady state within the specified time, Snowflake returns the current state.", "key": "timeout", "value": "1864" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] }, "description": "Fetch the status for a given service. Deprecated - use listServiceContainers instead." }, "response": [ { "name": "successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/status?timeout=1864", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "status" ], "query": [ { "description": "Number of seconds to wait for the service to reach a steady state (for example, READY) before returning the status. If the service does not reach a steady state within the specified time, Snowflake returns the current state.", "key": "timeout", "value": "1864" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Link", "value": "" } ], "cookie": [], "body": "{\n \"system$get_service_status\": \"string\"\n}" }, { "name": "Successfully accepted the request, but it is not completed yet.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/status?timeout=1864", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "status" ], "query": [ { "description": "Number of seconds to wait for the service to reach a steady state (for example, READY) before returning the status. If the service does not reach a steady state within the specified time, Snowflake returns the current state.", "key": "timeout", "value": "1864" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Location", "value": "string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"code\": \"392604\",\n \"message\": \"Request execution in progress. Use the provided location header or result handler ID to perform query monitoring and management.\"\n}" }, { "name": "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 r", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/status?timeout=1864", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "status" ], "query": [ { "description": "Number of seconds to wait for the service to reach a steady state (for example, READY) before returning the status. If the service does not reach a steady state within the specified time, Snowflake returns the current state.", "key": "timeout", "value": "1864" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/status?timeout=1864", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "status" ], "query": [ { "description": "Number of seconds to wait for the service to reach a steady state (for example, READY) before returning the status. If the service does not reach a steady state within the specified time, Snowflake returns the current state.", "key": "timeout", "value": "1864" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/status?timeout=1864", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "status" ], "query": [ { "description": "Number of seconds to wait for the service to reach a steady state (for example, READY) before returning the status. If the service does not reach a steady state within the specified time, Snowflake returns the current state.", "key": "timeout", "value": "1864" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/status?timeout=1864", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "status" ], "query": [ { "description": "Number of seconds to wait for the service to reach a steady state (for example, READY) before returning the status. If the service does not reach a steady state within the specified time, Snowflake returns the current state.", "key": "timeout", "value": "1864" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/status?timeout=1864", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "status" ], "query": [ { "description": "Number of seconds to wait for the service to reach a steady state (for example, READY) before returning the status. If the service does not reach a steady state within the specified time, Snowflake returns the current state.", "key": "timeout", "value": "1864" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/status?timeout=1864", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "status" ], "query": [ { "description": "Number of seconds to wait for the service to reach a steady state (for example, READY) before returning the status. If the service does not reach a steady state within the specified time, Snowflake returns the current state.", "key": "timeout", "value": "1864" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/status?timeout=1864", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "status" ], "query": [ { "description": "Number of seconds to wait for the service to reach a steady state (for example, READY) before returning the status. If the service does not reach a steady state within the specified time, Snowflake returns the current state.", "key": "timeout", "value": "1864" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/status?timeout=1864", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "status" ], "query": [ { "description": "Number of seconds to wait for the service to reach a steady state (for example, READY) before returning the status. If the service does not reach a steady state within the specified time, Snowflake returns the current state.", "key": "timeout", "value": "1864" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/status?timeout=1864", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "status" ], "query": [ { "description": "Number of seconds to wait for the service to reach a steady state (for example, READY) before returning the status. If the service does not reach a steady state within the specified time, Snowflake returns the current state.", "key": "timeout", "value": "1864" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Gateway Timeout", "code": 504, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" } ] } ] }, { "name": "containers", "item": [ { "name": "list Service Containers", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/containers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "containers" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] }, "description": "List all the containers of the service" }, "response": [ { "name": "successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/containers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "containers" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Link", "value": "" } ], "cookie": [], "body": "[\n {\n \"database_name\": \"testdb\",\n \"schema_name\": \"testschema\",\n \"service_name\": \"myservice\",\n \"instance_id\": \"0\",\n \"container_name\": \"main\",\n \"status\": \"PENDING\",\n \"message\": \"Pending scheduling.\",\n \"image_name\": \"/db/schema/repo/image:1.0\",\n \"image_digest\": \"abcdefd\",\n \"restart_count\": 0,\n \"start_time\": \"2023-01-01 00:00:00+00:00\"\n },\n {\n \"database_name\": \"testdb\",\n \"schema_name\": \"testschema\",\n \"service_name\": \"myservice\",\n \"instance_id\": \"0\",\n \"container_name\": \"main\",\n \"status\": \"PENDING\",\n \"message\": \"Pending scheduling.\",\n \"image_name\": \"/db/schema/repo/image:1.0\",\n \"image_digest\": \"abcdefd\",\n \"restart_count\": 0,\n \"start_time\": \"2023-01-01 00:00:00+00:00\"\n }\n]" }, { "name": "Successfully accepted the request, but it is not completed yet.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/containers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "containers" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Location", "value": "string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"code\": \"392604\",\n \"message\": \"Request execution in progress. Use the provided location header or result handler ID to perform query monitoring and management.\"\n}" }, { "name": "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 r", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/containers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "containers" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/containers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "containers" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/containers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "containers" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/containers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "containers" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/containers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "containers" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/containers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "containers" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/containers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "containers" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/containers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "containers" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/containers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "containers" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Gateway Timeout", "code": 504, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" } ] } ] }, { "name": "instances", "item": [ { "name": "list Service Instances", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/instances", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "instances" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] }, "description": "List all the instances of the service" }, "response": [ { "name": "successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/instances", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "instances" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Link", "value": "" } ], "cookie": [], "body": "[\n {\n \"database_name\": \"testdb\",\n \"schema_name\": \"testschema\",\n \"service_name\": \"myservice\",\n \"instance_id\": \"0\",\n \"status\": \"PENDING\",\n \"spec_digest\": \"abcdefg\",\n \"creation_time\": \"2023-01-01 00:00:00+00:00\",\n \"start_time\": \"2023-01-01 00:00:00+00:00\"\n },\n {\n \"database_name\": \"testdb\",\n \"schema_name\": \"testschema\",\n \"service_name\": \"myservice\",\n \"instance_id\": \"0\",\n \"status\": \"PENDING\",\n \"spec_digest\": \"abcdefg\",\n \"creation_time\": \"2023-01-01 00:00:00+00:00\",\n \"start_time\": \"2023-01-01 00:00:00+00:00\"\n }\n]" }, { "name": "Successfully accepted the request, but it is not completed yet.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/instances", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "instances" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Location", "value": "string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"code\": \"392604\",\n \"message\": \"Request execution in progress. Use the provided location header or result handler ID to perform query monitoring and management.\"\n}" }, { "name": "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 r", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/instances", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "instances" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/instances", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "instances" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/instances", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "instances" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/instances", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "instances" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/instances", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "instances" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/instances", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "instances" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/instances", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "instances" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/instances", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "instances" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/instances", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "instances" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Gateway Timeout", "code": 504, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" } ] } ] }, { "name": "roles", "item": [ { "name": "list Service Roles", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/roles", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "roles" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] }, "description": "List all the service roles of the service" }, "response": [ { "name": "successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/roles", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "roles" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Link", "value": "" } ], "cookie": [], "body": "[\n {\n \"created_on\": \"2023-01-01 00:00:00+00:00\",\n \"name\": \"testrole\",\n \"comment\": \"This is a service role.\"\n },\n {\n \"created_on\": \"2023-01-01 00:00:00+00:00\",\n \"name\": \"testrole\",\n \"comment\": \"This is a service role.\"\n }\n]" }, { "name": "Successfully accepted the request, but it is not completed yet.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/roles", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "roles" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Location", "value": "string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"code\": \"392604\",\n \"message\": \"Request execution in progress. Use the provided location header or result handler ID to perform query monitoring and management.\"\n}" }, { "name": "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 r", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/roles", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "roles" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/roles", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "roles" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/roles", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "roles" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/roles", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "roles" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/roles", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "roles" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/roles", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "roles" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/roles", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "roles" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/roles", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "roles" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/roles", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "roles" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Gateway Timeout", "code": 504, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" } ] } ] }, { "name": "endpoints", "item": [ { "name": "List the endpoints in a service.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/endpoints", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "endpoints" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] }, "description": "Lists the endpoints in a Snowpark Container Services service (or a job service)." }, "response": [ { "name": "successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/endpoints", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "endpoints" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Link", "value": "" } ], "cookie": [], "body": "[\n {\n \"name\": \"endpoint\",\n \"port\": 8080,\n \"protocol\": \"HTTPS\",\n \"is_public\": true,\n \"ingress_url\": \"abcd-org-acc.snowflakecomputing.app\"\n },\n {\n \"name\": \"endpoint\",\n \"port\": 8080,\n \"protocol\": \"HTTPS\",\n \"is_public\": true,\n \"ingress_url\": \"abcd-org-acc.snowflakecomputing.app\"\n }\n]" }, { "name": "Successfully accepted the request, but it is not completed yet.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/endpoints", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "endpoints" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Location", "value": "string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"code\": \"392604\",\n \"message\": \"Request execution in progress. Use the provided location header or result handler ID to perform query monitoring and management.\"\n}" }, { "name": "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 r", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/endpoints", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "endpoints" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/endpoints", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "endpoints" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/endpoints", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "endpoints" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/endpoints", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "endpoints" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/endpoints", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "endpoints" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/endpoints", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "endpoints" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/endpoints", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "endpoints" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/endpoints", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "endpoints" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/endpoints", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name", "endpoints" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Gateway Timeout", "code": 504, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" } ] } ] }, { "name": "fetch Service", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] }, "description": "Fetch a service." }, "response": [ { "name": "successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Link", "value": "" } ], "cookie": [], "body": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n },\n \"min_ready_instances\": 1,\n \"min_instances\": 2,\n \"max_instances\": 5,\n \"database_name\": \"testdb\",\n \"schema_name\": \"testschema\",\n \"owner\": \"SYSADMIN\",\n \"is_job\": false\n}" }, { "name": "Successfully accepted the request, but it is not completed yet.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Location", "value": "string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"code\": \"392604\",\n \"message\": \"Request execution in progress. Use the provided location header or result handler ID to perform query monitoring and management.\"\n}" }, { "name": "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 r", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Gateway Timeout", "code": 504, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" } ] }, { "name": "Create a (or alter an existing) service.", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n },\n \"min_ready_instances\": 1,\n \"min_instances\": 2,\n \"max_instances\": 5,\n \"database_name\": \"testdb\",\n \"schema_name\": \"testschema\",\n \"owner\": \"SYSADMIN\",\n \"is_job\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] }, "description": "Create a (or alter an existing) service. Even if the operation is just an alter, the full property set must be provided." }, "response": [ { "name": "Successful request", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n },\n \"min_ready_instances\": 1,\n \"min_instances\": 2,\n \"max_instances\": 5,\n \"database_name\": \"testdb\",\n \"schema_name\": \"testschema\",\n \"owner\": \"SYSADMIN\",\n \"is_job\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Link", "value": "" } ], "cookie": [], "body": "{\n \"status\": \"Request successfully completed\"\n}" }, { "name": "Successfully accepted the request, but it is not completed yet.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n },\n \"min_ready_instances\": 1,\n \"min_instances\": 2,\n \"max_instances\": 5,\n \"database_name\": \"testdb\",\n \"schema_name\": \"testschema\",\n \"owner\": \"SYSADMIN\",\n \"is_job\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Location", "value": "string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"code\": \"392604\",\n \"message\": \"Request execution in progress. Use the provided location header or result handler ID to perform query monitoring and management.\"\n}" }, { "name": "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 r", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n },\n \"min_ready_instances\": 1,\n \"min_instances\": 2,\n \"max_instances\": 5,\n \"database_name\": \"testdb\",\n \"schema_name\": \"testschema\",\n \"owner\": \"SYSADMIN\",\n \"is_job\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n },\n \"min_ready_instances\": 1,\n \"min_instances\": 2,\n \"max_instances\": 5,\n \"database_name\": \"testdb\",\n \"schema_name\": \"testschema\",\n \"owner\": \"SYSADMIN\",\n \"is_job\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n },\n \"min_ready_instances\": 1,\n \"min_instances\": 2,\n \"max_instances\": 5,\n \"database_name\": \"testdb\",\n \"schema_name\": \"testschema\",\n \"owner\": \"SYSADMIN\",\n \"is_job\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n },\n \"min_ready_instances\": 1,\n \"min_instances\": 2,\n \"max_instances\": 5,\n \"database_name\": \"testdb\",\n \"schema_name\": \"testschema\",\n \"owner\": \"SYSADMIN\",\n \"is_job\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n },\n \"min_ready_instances\": 1,\n \"min_instances\": 2,\n \"max_instances\": 5,\n \"database_name\": \"testdb\",\n \"schema_name\": \"testschema\",\n \"owner\": \"SYSADMIN\",\n \"is_job\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n },\n \"min_ready_instances\": 1,\n \"min_instances\": 2,\n \"max_instances\": 5,\n \"database_name\": \"testdb\",\n \"schema_name\": \"testschema\",\n \"owner\": \"SYSADMIN\",\n \"is_job\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n },\n \"min_ready_instances\": 1,\n \"min_instances\": 2,\n \"max_instances\": 5,\n \"database_name\": \"testdb\",\n \"schema_name\": \"testschema\",\n \"owner\": \"SYSADMIN\",\n \"is_job\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n },\n \"min_ready_instances\": 1,\n \"min_instances\": 2,\n \"max_instances\": 5,\n \"database_name\": \"testdb\",\n \"schema_name\": \"testschema\",\n \"owner\": \"SYSADMIN\",\n \"is_job\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Gateway Timeout", "code": 504, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" } ] }, { "name": "Delete a service", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] }, "description": "Delete a service with the given name. If ifExists is used, the operation will succeed even if the object does not exist. Otherwise, there will be a failure if the drop is unsuccessful." }, "response": [ { "name": "Successful request.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"status\": \"Request successfully completed\"\n}" }, { "name": "Successfully accepted the request, but it is not completed yet.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Location", "value": "string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"code\": \"392604\",\n \"message\": \"Request execution in progress. Use the provided location header or result handler ID to perform query monitoring and management.\"\n}" }, { "name": "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 r", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":name" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Gateway Timeout", "code": 504, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" } ] } ] }, { "name": "{service}", "item": [ { "name": "roles", "item": [ { "name": "{name}", "item": [ { "name": "grants-of", "item": [ { "name": "list Service Role Grants Of", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants-of", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":service", "roles", ":name", "grants-of" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "service", "value": "TEST_NAME", "description": "Name of the service that contains the service role." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] }, "description": "List all the grants of the service role" }, "response": [ { "name": "successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants-of", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":service", "roles", ":name", "grants-of" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "service", "value": "TEST_NAME", "description": "Name of the service that contains the service role." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Link", "value": "" } ], "cookie": [], "body": "[\n {\n \"created_on\": \"2023-01-01 00:00:00+00:00\",\n \"role\": \"db.schema.service.svc_role\",\n \"granted_to\": \"role\",\n \"grantee_name\": \"test_role\",\n \"granted_by\": \"sysadmin\"\n },\n {\n \"created_on\": \"2023-01-01 00:00:00+00:00\",\n \"role\": \"db.schema.service.svc_role\",\n \"granted_to\": \"role\",\n \"grantee_name\": \"test_role\",\n \"granted_by\": \"sysadmin\"\n }\n]" }, { "name": "Successfully accepted the request, but it is not completed yet.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants-of", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":service", "roles", ":name", "grants-of" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "service", "value": "TEST_NAME", "description": "Name of the service that contains the service role." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Location", "value": "string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"code\": \"392604\",\n \"message\": \"Request execution in progress. Use the provided location header or result handler ID to perform query monitoring and management.\"\n}" }, { "name": "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 r", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants-of", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":service", "roles", ":name", "grants-of" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "service", "value": "TEST_NAME", "description": "Name of the service that contains the service role." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants-of", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":service", "roles", ":name", "grants-of" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "service", "value": "TEST_NAME", "description": "Name of the service that contains the service role." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants-of", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":service", "roles", ":name", "grants-of" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "service", "value": "TEST_NAME", "description": "Name of the service that contains the service role." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants-of", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":service", "roles", ":name", "grants-of" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "service", "value": "TEST_NAME", "description": "Name of the service that contains the service role." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants-of", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":service", "roles", ":name", "grants-of" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "service", "value": "TEST_NAME", "description": "Name of the service that contains the service role." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants-of", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":service", "roles", ":name", "grants-of" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "service", "value": "TEST_NAME", "description": "Name of the service that contains the service role." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants-of", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":service", "roles", ":name", "grants-of" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "service", "value": "TEST_NAME", "description": "Name of the service that contains the service role." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants-of", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":service", "roles", ":name", "grants-of" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "service", "value": "TEST_NAME", "description": "Name of the service that contains the service role." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants-of", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":service", "roles", ":name", "grants-of" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "service", "value": "TEST_NAME", "description": "Name of the service that contains the service role." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Gateway Timeout", "code": 504, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" } ] } ] }, { "name": "grants", "item": [ { "name": "list Service Role Grants To", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":service", "roles", ":name", "grants" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "service", "value": "TEST_NAME", "description": "Name of the service that contains the service role." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] }, "description": "List all the grants given to the service role" }, "response": [ { "name": "successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":service", "roles", ":name", "grants" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "service", "value": "TEST_NAME", "description": "Name of the service that contains the service role." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Link", "value": "" } ], "cookie": [], "body": "[\n {\n \"created_on\": \"2023-01-01 00:00:00+00:00\",\n \"privilege\": \"usage\",\n \"granted_on\": \"service_endpoint\",\n \"name\": \"db.schema.service!svc_role\",\n \"granted_to\": \"service role\",\n \"grantee_name\": \"all_endpoints_usage\"\n },\n {\n \"created_on\": \"2023-01-01 00:00:00+00:00\",\n \"privilege\": \"usage\",\n \"granted_on\": \"service_endpoint\",\n \"name\": \"db.schema.service!svc_role\",\n \"granted_to\": \"service role\",\n \"grantee_name\": \"all_endpoints_usage\"\n }\n]" }, { "name": "Successfully accepted the request, but it is not completed yet.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":service", "roles", ":name", "grants" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "service", "value": "TEST_NAME", "description": "Name of the service that contains the service role." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Location", "value": "string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"code\": \"392604\",\n \"message\": \"Request execution in progress. Use the provided location header or result handler ID to perform query monitoring and management.\"\n}" }, { "name": "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 r", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":service", "roles", ":name", "grants" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "service", "value": "TEST_NAME", "description": "Name of the service that contains the service role." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":service", "roles", ":name", "grants" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "service", "value": "TEST_NAME", "description": "Name of the service that contains the service role." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":service", "roles", ":name", "grants" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "service", "value": "TEST_NAME", "description": "Name of the service that contains the service role." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":service", "roles", ":name", "grants" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "service", "value": "TEST_NAME", "description": "Name of the service that contains the service role." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":service", "roles", ":name", "grants" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "service", "value": "TEST_NAME", "description": "Name of the service that contains the service role." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":service", "roles", ":name", "grants" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "service", "value": "TEST_NAME", "description": "Name of the service that contains the service role." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":service", "roles", ":name", "grants" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "service", "value": "TEST_NAME", "description": "Name of the service that contains the service role." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":service", "roles", ":name", "grants" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "service", "value": "TEST_NAME", "description": "Name of the service that contains the service role." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", ":service", "roles", ":name", "grants" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "service", "value": "TEST_NAME", "description": "Name of the service that contains the service role." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Gateway Timeout", "code": 504, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" } ] } ] } ] } ] } ] }, { "name": "{name}:resume", "item": [ { "name": "resume Service", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:resume?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", "{{name}}:resume" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] }, "description": "Resume a service." }, "response": [ { "name": "Successful request.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:resume?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", "{{name}}:resume" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"status\": \"Request successfully completed\"\n}" }, { "name": "Successfully accepted the request, but it is not completed yet.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:resume?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", "{{name}}:resume" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Location", "value": "string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"code\": \"392604\",\n \"message\": \"Request execution in progress. Use the provided location header or result handler ID to perform query monitoring and management.\"\n}" }, { "name": "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 r", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:resume?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", "{{name}}:resume" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:resume?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", "{{name}}:resume" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:resume?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", "{{name}}:resume" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:resume?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", "{{name}}:resume" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:resume?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", "{{name}}:resume" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:resume?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", "{{name}}:resume" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:resume?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", "{{name}}:resume" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:resume?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", "{{name}}:resume" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:resume?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", "{{name}}:resume" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Gateway Timeout", "code": 504, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" } ] } ] }, { "name": "{name}:suspend", "item": [ { "name": "suspend Service", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:suspend?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", "{{name}}:suspend" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] }, "description": "Suspend a service." }, "response": [ { "name": "Successful request.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:suspend?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", "{{name}}:suspend" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"status\": \"Request successfully completed\"\n}" }, { "name": "Successfully accepted the request, but it is not completed yet.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:suspend?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", "{{name}}:suspend" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Location", "value": "string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"code\": \"392604\",\n \"message\": \"Request execution in progress. Use the provided location header or result handler ID to perform query monitoring and management.\"\n}" }, { "name": "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 r", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:suspend?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", "{{name}}:suspend" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:suspend?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", "{{name}}:suspend" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:suspend?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", "{{name}}:suspend" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:suspend?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", "{{name}}:suspend" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:suspend?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", "{{name}}:suspend" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:suspend?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", "{{name}}:suspend" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:suspend?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", "{{name}}:suspend" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:suspend?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", "{{name}}:suspend" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:suspend?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services", "{{name}}:suspend" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `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.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Gateway Timeout", "code": 504, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" } ] } ] }, { "name": "List services", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?like=test_%&startsWith=test&showLimit=10&fromName=from_test", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services" ], "query": [ { "description": "Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.", "key": "like", "value": "test_%" }, { "description": "Parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching.", "key": "startsWith", "value": "test" }, { "description": "Parameter to limit the maximum number of rows returned by a command.", "key": "showLimit", "value": "10" }, { "description": "Parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name.", "key": "fromName", "value": "from_test" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] }, "description": "Lists the services under the database and schema." }, "response": [ { "name": "successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?like=test_%&startsWith=test&showLimit=10&fromName=from_test", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services" ], "query": [ { "description": "Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.", "key": "like", "value": "test_%" }, { "description": "Parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching.", "key": "startsWith", "value": "test" }, { "description": "Parameter to limit the maximum number of rows returned by a command.", "key": "showLimit", "value": "10" }, { "description": "Parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name.", "key": "fromName", "value": "from_test" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Link", "value": "" } ], "cookie": [], "body": "[]" }, { "name": "Successfully accepted the request, but it is not completed yet.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?like=test_%&startsWith=test&showLimit=10&fromName=from_test", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services" ], "query": [ { "description": "Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.", "key": "like", "value": "test_%" }, { "description": "Parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching.", "key": "startsWith", "value": "test" }, { "description": "Parameter to limit the maximum number of rows returned by a command.", "key": "showLimit", "value": "10" }, { "description": "Parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name.", "key": "fromName", "value": "from_test" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Location", "value": "string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"code\": \"392604\",\n \"message\": \"Request execution in progress. Use the provided location header or result handler ID to perform query monitoring and management.\"\n}" }, { "name": "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 r", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?like=test_%&startsWith=test&showLimit=10&fromName=from_test", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services" ], "query": [ { "description": "Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.", "key": "like", "value": "test_%" }, { "description": "Parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching.", "key": "startsWith", "value": "test" }, { "description": "Parameter to limit the maximum number of rows returned by a command.", "key": "showLimit", "value": "10" }, { "description": "Parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name.", "key": "fromName", "value": "from_test" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?like=test_%&startsWith=test&showLimit=10&fromName=from_test", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services" ], "query": [ { "description": "Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.", "key": "like", "value": "test_%" }, { "description": "Parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching.", "key": "startsWith", "value": "test" }, { "description": "Parameter to limit the maximum number of rows returned by a command.", "key": "showLimit", "value": "10" }, { "description": "Parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name.", "key": "fromName", "value": "from_test" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?like=test_%&startsWith=test&showLimit=10&fromName=from_test", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services" ], "query": [ { "description": "Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.", "key": "like", "value": "test_%" }, { "description": "Parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching.", "key": "startsWith", "value": "test" }, { "description": "Parameter to limit the maximum number of rows returned by a command.", "key": "showLimit", "value": "10" }, { "description": "Parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name.", "key": "fromName", "value": "from_test" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?like=test_%&startsWith=test&showLimit=10&fromName=from_test", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services" ], "query": [ { "description": "Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.", "key": "like", "value": "test_%" }, { "description": "Parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching.", "key": "startsWith", "value": "test" }, { "description": "Parameter to limit the maximum number of rows returned by a command.", "key": "showLimit", "value": "10" }, { "description": "Parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name.", "key": "fromName", "value": "from_test" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?like=test_%&startsWith=test&showLimit=10&fromName=from_test", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services" ], "query": [ { "description": "Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.", "key": "like", "value": "test_%" }, { "description": "Parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching.", "key": "startsWith", "value": "test" }, { "description": "Parameter to limit the maximum number of rows returned by a command.", "key": "showLimit", "value": "10" }, { "description": "Parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name.", "key": "fromName", "value": "from_test" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?like=test_%&startsWith=test&showLimit=10&fromName=from_test", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services" ], "query": [ { "description": "Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.", "key": "like", "value": "test_%" }, { "description": "Parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching.", "key": "startsWith", "value": "test" }, { "description": "Parameter to limit the maximum number of rows returned by a command.", "key": "showLimit", "value": "10" }, { "description": "Parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name.", "key": "fromName", "value": "from_test" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?like=test_%&startsWith=test&showLimit=10&fromName=from_test", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services" ], "query": [ { "description": "Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.", "key": "like", "value": "test_%" }, { "description": "Parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching.", "key": "startsWith", "value": "test" }, { "description": "Parameter to limit the maximum number of rows returned by a command.", "key": "showLimit", "value": "10" }, { "description": "Parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name.", "key": "fromName", "value": "from_test" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?like=test_%&startsWith=test&showLimit=10&fromName=from_test", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services" ], "query": [ { "description": "Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.", "key": "like", "value": "test_%" }, { "description": "Parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching.", "key": "startsWith", "value": "test" }, { "description": "Parameter to limit the maximum number of rows returned by a command.", "key": "showLimit", "value": "10" }, { "description": "Parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name.", "key": "fromName", "value": "from_test" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?like=test_%&startsWith=test&showLimit=10&fromName=from_test", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services" ], "query": [ { "description": "Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.", "key": "like", "value": "test_%" }, { "description": "Parameter to filter the command output based on the string of characters that appear at the beginning of the object name. Uses case-sensitive pattern matching.", "key": "startsWith", "value": "test" }, { "description": "Parameter to limit the maximum number of rows returned by a command.", "key": "showLimit", "value": "10" }, { "description": "Parameter to enable fetching rows only following the first row whose object name matches the specified string. Case-sensitive and does not have to be the full name.", "key": "fromName", "value": "from_test" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Gateway Timeout", "code": 504, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" } ] }, { "name": "Create a service", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n },\n \"min_ready_instances\": 1,\n \"min_instances\": 2,\n \"max_instances\": 5,\n \"database_name\": \"testdb\",\n \"schema_name\": \"testschema\",\n \"owner\": \"SYSADMIN\",\n \"is_job\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?createMode=errorIfExists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services" ], "query": [ { "description": "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. - `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.", "key": "createMode", "value": "errorIfExists" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] }, "description": "Create a service, with standard create modifiers as query parameters. See the Service component definition for what is required to be provided in the request body." }, "response": [ { "name": "Successful request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n },\n \"min_ready_instances\": 1,\n \"min_instances\": 2,\n \"max_instances\": 5,\n \"database_name\": \"testdb\",\n \"schema_name\": \"testschema\",\n \"owner\": \"SYSADMIN\",\n \"is_job\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?createMode=errorIfExists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services" ], "query": [ { "description": "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. - `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.", "key": "createMode", "value": "errorIfExists" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"status\": \"Request successfully completed\"\n}" }, { "name": "Successfully accepted the request, but it is not completed yet.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n },\n \"min_ready_instances\": 1,\n \"min_instances\": 2,\n \"max_instances\": 5,\n \"database_name\": \"testdb\",\n \"schema_name\": \"testschema\",\n \"owner\": \"SYSADMIN\",\n \"is_job\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?createMode=errorIfExists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services" ], "query": [ { "description": "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. - `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.", "key": "createMode", "value": "errorIfExists" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Location", "value": "string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"code\": \"392604\",\n \"message\": \"Request execution in progress. Use the provided location header or result handler ID to perform query monitoring and management.\"\n}" }, { "name": "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 r", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n },\n \"min_ready_instances\": 1,\n \"min_instances\": 2,\n \"max_instances\": 5,\n \"database_name\": \"testdb\",\n \"schema_name\": \"testschema\",\n \"owner\": \"SYSADMIN\",\n \"is_job\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?createMode=errorIfExists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services" ], "query": [ { "description": "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. - `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.", "key": "createMode", "value": "errorIfExists" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n },\n \"min_ready_instances\": 1,\n \"min_instances\": 2,\n \"max_instances\": 5,\n \"database_name\": \"testdb\",\n \"schema_name\": \"testschema\",\n \"owner\": \"SYSADMIN\",\n \"is_job\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?createMode=errorIfExists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services" ], "query": [ { "description": "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. - `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.", "key": "createMode", "value": "errorIfExists" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n },\n \"min_ready_instances\": 1,\n \"min_instances\": 2,\n \"max_instances\": 5,\n \"database_name\": \"testdb\",\n \"schema_name\": \"testschema\",\n \"owner\": \"SYSADMIN\",\n \"is_job\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?createMode=errorIfExists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services" ], "query": [ { "description": "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. - `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.", "key": "createMode", "value": "errorIfExists" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n },\n \"min_ready_instances\": 1,\n \"min_instances\": 2,\n \"max_instances\": 5,\n \"database_name\": \"testdb\",\n \"schema_name\": \"testschema\",\n \"owner\": \"SYSADMIN\",\n \"is_job\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?createMode=errorIfExists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services" ], "query": [ { "description": "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. - `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.", "key": "createMode", "value": "errorIfExists" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n },\n \"min_ready_instances\": 1,\n \"min_instances\": 2,\n \"max_instances\": 5,\n \"database_name\": \"testdb\",\n \"schema_name\": \"testschema\",\n \"owner\": \"SYSADMIN\",\n \"is_job\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?createMode=errorIfExists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services" ], "query": [ { "description": "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. - `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.", "key": "createMode", "value": "errorIfExists" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n },\n \"min_ready_instances\": 1,\n \"min_instances\": 2,\n \"max_instances\": 5,\n \"database_name\": \"testdb\",\n \"schema_name\": \"testschema\",\n \"owner\": \"SYSADMIN\",\n \"is_job\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?createMode=errorIfExists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services" ], "query": [ { "description": "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. - `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.", "key": "createMode", "value": "errorIfExists" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Request Timeout", "code": 408, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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 ", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n },\n \"min_ready_instances\": 1,\n \"min_instances\": 2,\n \"max_instances\": 5,\n \"database_name\": \"testdb\",\n \"schema_name\": \"testschema\",\n \"owner\": \"SYSADMIN\",\n \"is_job\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?createMode=errorIfExists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services" ], "query": [ { "description": "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. - `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.", "key": "createMode", "value": "errorIfExists" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n },\n \"min_ready_instances\": 1,\n \"min_instances\": 2,\n \"max_instances\": 5,\n \"database_name\": \"testdb\",\n \"schema_name\": \"testschema\",\n \"owner\": \"SYSADMIN\",\n \"is_job\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?createMode=errorIfExists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services" ], "query": [ { "description": "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. - `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.", "key": "createMode", "value": "errorIfExists" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n },\n \"min_ready_instances\": 1,\n \"min_instances\": 2,\n \"max_instances\": 5,\n \"database_name\": \"testdb\",\n \"schema_name\": \"testschema\",\n \"owner\": \"SYSADMIN\",\n \"is_job\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?createMode=errorIfExists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services" ], "query": [ { "description": "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. - `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.", "key": "createMode", "value": "errorIfExists" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n },\n \"min_ready_instances\": 1,\n \"min_instances\": 2,\n \"max_instances\": 5,\n \"database_name\": \"testdb\",\n \"schema_name\": \"testschema\",\n \"owner\": \"SYSADMIN\",\n \"is_job\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?createMode=errorIfExists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services" ], "query": [ { "description": "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. - `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.", "key": "createMode", "value": "errorIfExists" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n },\n \"min_ready_instances\": 1,\n \"min_instances\": 2,\n \"max_instances\": 5,\n \"database_name\": \"testdb\",\n \"schema_name\": \"testschema\",\n \"owner\": \"SYSADMIN\",\n \"is_job\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?createMode=errorIfExists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services" ], "query": [ { "description": "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. - `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.", "key": "createMode", "value": "errorIfExists" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Gateway Timeout", "code": 504, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" } ] } ] }, { "name": "services:execute-job", "item": [ { "name": "Execute a job service", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services:execute-job", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services:execute-job" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] }, "description": "Create and execute a job service. See the JobService component definition for what is required to be provided in the request body." }, "response": [ { "name": "Successful request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services:execute-job", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services:execute-job" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"status\": \"Request successfully completed\"\n}" }, { "name": "Successfully accepted the request, but it is not completed yet.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services:execute-job", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services:execute-job" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Location", "value": "string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"code\": \"392604\",\n \"message\": \"Request execution in progress. Use the provided location header or result handler ID to perform query monitoring and management.\"\n}" }, { "name": "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 r", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services:execute-job", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services:execute-job" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services:execute-job", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services:execute-job" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services:execute-job", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services:execute-job" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services:execute-job", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services:execute-job" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services:execute-job", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services:execute-job" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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 ", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services:execute-job", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services:execute-job" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services:execute-job", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services:execute-job" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "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.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services:execute-job", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services:execute-job" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services:execute-job", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services:execute-job" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"service_name\",\n \"compute_pool\": \"compute_pool_name\",\n \"spec\": {\n \"spec_type\": \"from_file\",\n \"stage\": \"@stage_name\",\n \"spec_file\": \"spec_file.yaml\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services:execute-job", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "services:execute-job" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Gateway Timeout", "code": 504, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" } ] } ] } ] } ] } ] } ] } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://org-account.snowflakecomputing.com" }, { "key": "name", "value": "TEST_NAME" } ] }