From e6fe0005bbfc3a4fa553404db2ddfc1cc3021ee8 Mon Sep 17 00:00:00 2001 From: Zihan Li Date: Tue, 13 Aug 2024 13:05:52 -0700 Subject: [PATCH] release public preview --- ...Cortex Analyst API.postman_collection.json | 656 + ...rtex Inference API.postman_collection.json | 584 + ...ex Search REST API.postman_collection.json | 801 + ... Compute Pools API.postman_collection.json | 4906 ++++ ...flake Database API.postman_collection.json | 11981 ++++++++++ ... Dynamic Table API.postman_collection.json | 11314 +++++++++ ...flake Function API.postman_collection.json | 4062 ++++ ...nowflake Grant API.postman_collection.json | 7441 ++++++ ...age Repository API.postman_collection.json | 4001 ++++ ...owflake Result API.postman_collection.json | 692 + ...Snowflake Role API.postman_collection.json | 2564 ++ ...owflake Schema API.postman_collection.json | 6666 ++++++ ...flake Services API.postman_collection.json | 7328 ++++++ ...nowflake Stage API.postman_collection.json | 4980 ++++ ...nowflake Table API.postman_collection.json | 19286 ++++++++++++++++ ...Snowflake Task API.postman_collection.json | 10546 +++++++++ ...Snowflake User API.postman_collection.json | 3230 +++ ...lake Warehouse API.postman_collection.json | 7422 ++++++ public-preview/8.30/specification/common.yaml | 530 + .../8.30/specification/compute-pool.yaml | 422 + .../8.30/specification/cortex-analyst.yaml | 256 + .../8.30/specification/cortex-inference.yaml | 152 + .../specification/cortex-search-service.yaml | 104 + .../8.30/specification/database.yaml | 793 + .../8.30/specification/dynamic-table.yaml | 722 + .../8.30/specification/function.yaml | 324 + public-preview/8.30/specification/grant.yaml | 481 + .../8.30/specification/image-repository.yaml | 270 + public-preview/8.30/specification/result.yaml | 68 + public-preview/8.30/specification/role.yaml | 197 + public-preview/8.30/specification/schema.yaml | 486 + .../8.30/specification/service.yaml | 556 + public-preview/8.30/specification/stage.yaml | 502 + public-preview/8.30/specification/table.yaml | 1157 + public-preview/8.30/specification/task.yaml | 900 + public-preview/8.30/specification/user.yaml | 325 + .../8.30/specification/warehouse.yaml | 610 + 37 files changed, 117315 insertions(+) create mode 100644 public-preview/8.30/collection/Cortex Analyst API.postman_collection.json create mode 100644 public-preview/8.30/collection/Cortex Inference API.postman_collection.json create mode 100644 public-preview/8.30/collection/Cortex Search REST API.postman_collection.json create mode 100644 public-preview/8.30/collection/Snowflake Compute Pools API.postman_collection.json create mode 100644 public-preview/8.30/collection/Snowflake Database API.postman_collection.json create mode 100644 public-preview/8.30/collection/Snowflake Dynamic Table API.postman_collection.json create mode 100644 public-preview/8.30/collection/Snowflake Function API.postman_collection.json create mode 100644 public-preview/8.30/collection/Snowflake Grant API.postman_collection.json create mode 100644 public-preview/8.30/collection/Snowflake Image Repository API.postman_collection.json create mode 100644 public-preview/8.30/collection/Snowflake Result API.postman_collection.json create mode 100644 public-preview/8.30/collection/Snowflake Role API.postman_collection.json create mode 100644 public-preview/8.30/collection/Snowflake Schema API.postman_collection.json create mode 100644 public-preview/8.30/collection/Snowflake Services API.postman_collection.json create mode 100644 public-preview/8.30/collection/Snowflake Stage API.postman_collection.json create mode 100644 public-preview/8.30/collection/Snowflake Table API.postman_collection.json create mode 100644 public-preview/8.30/collection/Snowflake Task API.postman_collection.json create mode 100644 public-preview/8.30/collection/Snowflake User API.postman_collection.json create mode 100644 public-preview/8.30/collection/Snowflake Warehouse API.postman_collection.json create mode 100644 public-preview/8.30/specification/common.yaml create mode 100644 public-preview/8.30/specification/compute-pool.yaml create mode 100644 public-preview/8.30/specification/cortex-analyst.yaml create mode 100644 public-preview/8.30/specification/cortex-inference.yaml create mode 100644 public-preview/8.30/specification/cortex-search-service.yaml create mode 100644 public-preview/8.30/specification/database.yaml create mode 100644 public-preview/8.30/specification/dynamic-table.yaml create mode 100644 public-preview/8.30/specification/function.yaml create mode 100644 public-preview/8.30/specification/grant.yaml create mode 100644 public-preview/8.30/specification/image-repository.yaml create mode 100644 public-preview/8.30/specification/result.yaml create mode 100644 public-preview/8.30/specification/role.yaml create mode 100644 public-preview/8.30/specification/schema.yaml create mode 100644 public-preview/8.30/specification/service.yaml create mode 100644 public-preview/8.30/specification/stage.yaml create mode 100644 public-preview/8.30/specification/table.yaml create mode 100644 public-preview/8.30/specification/task.yaml create mode 100644 public-preview/8.30/specification/user.yaml create mode 100644 public-preview/8.30/specification/warehouse.yaml diff --git a/public-preview/8.30/collection/Cortex Analyst API.postman_collection.json b/public-preview/8.30/collection/Cortex Analyst API.postman_collection.json new file mode 100644 index 0000000..4cbf720 --- /dev/null +++ b/public-preview/8.30/collection/Cortex Analyst API.postman_collection.json @@ -0,0 +1,656 @@ +{ + "info": { + "_postman_id": "de474f82-81ec-4513-9d6c-9e542863a898", + "name": "Cortex Analyst API", + "description": "The Snowflake Cortex Analyst API is a REST API that allows end user to chat with their data leveraging semantic models to generate SQL queries.\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": "28868798", + "_collection_link": "https://snowflake.postman.co/workspace/SnowApi-PuPr~785f3044-d2f3-4a33-8fea-8707898185ed/collection/28868798-de474f82-81ec-4513-9d6c-9e542863a898?action=share&source=collection_link&creator=28868798" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "cortex", + "item": [ + { + "name": "analyst", + "item": [ + { + "name": "message", + "item": [ + { + "name": "Send a data question to the Cortex Analyst", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"messages\": [\n {\n \"content\": [\n {\n \"type\": \"sql\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"user\"\n },\n {\n \"content\": [\n {\n \"type\": \"suggestions\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"user\"\n }\n ],\n \"semantic_model_file\": \"\",\n \"semantic_model\": \"\",\n \"stream\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/cortex/analyst/message", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "cortex", + "analyst", + "message" + ] + } + }, + "response": [ + { + "name": "OK", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"messages\": [\n {\n \"content\": [\n {\n \"type\": \"sql\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"user\"\n },\n {\n \"content\": [\n {\n \"type\": \"suggestions\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"user\"\n }\n ],\n \"semantic_model_file\": \"\",\n \"semantic_model\": \"\",\n \"stream\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/cortex/analyst/message", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "cortex", + "analyst", + "message" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": {\n \"content\": [\n {\n \"type\": \"suggestions\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"analyst\"\n },\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"messages\": [\n {\n \"content\": [\n {\n \"type\": \"sql\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"user\"\n },\n {\n \"content\": [\n {\n \"type\": \"suggestions\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"user\"\n }\n ],\n \"semantic_model_file\": \"\",\n \"semantic_model\": \"\",\n \"stream\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/cortex/analyst/message", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "cortex", + "analyst", + "message" + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "Unique ID of the API request.", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"messages\": [\n {\n \"content\": [\n {\n \"type\": \"sql\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"user\"\n },\n {\n \"content\": [\n {\n \"type\": \"suggestions\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"user\"\n }\n ],\n \"semantic_model_file\": \"\",\n \"semantic_model\": \"\",\n \"stream\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/cortex/analyst/message", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "cortex", + "analyst", + "message" + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "Unique ID of the API request.", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"messages\": [\n {\n \"content\": [\n {\n \"type\": \"sql\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"user\"\n },\n {\n \"content\": [\n {\n \"type\": \"suggestions\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"user\"\n }\n ],\n \"semantic_model_file\": \"\",\n \"semantic_model\": \"\",\n \"stream\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/cortex/analyst/message", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "cortex", + "analyst", + "message" + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "Unique ID of the API request.", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"messages\": [\n {\n \"content\": [\n {\n \"type\": \"sql\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"user\"\n },\n {\n \"content\": [\n {\n \"type\": \"suggestions\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"user\"\n }\n ],\n \"semantic_model_file\": \"\",\n \"semantic_model\": \"\",\n \"stream\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/cortex/analyst/message", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "cortex", + "analyst", + "message" + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "Unique ID of the API request.", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"messages\": [\n {\n \"content\": [\n {\n \"type\": \"sql\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"user\"\n },\n {\n \"content\": [\n {\n \"type\": \"suggestions\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"user\"\n }\n ],\n \"semantic_model_file\": \"\",\n \"semantic_model\": \"\",\n \"stream\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/cortex/analyst/message", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "cortex", + "analyst", + "message" + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "Unique ID of the API request.", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"messages\": [\n {\n \"content\": [\n {\n \"type\": \"sql\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"user\"\n },\n {\n \"content\": [\n {\n \"type\": \"suggestions\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"user\"\n }\n ],\n \"semantic_model_file\": \"\",\n \"semantic_model\": \"\",\n \"stream\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/cortex/analyst/message", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "cortex", + "analyst", + "message" + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "Unique ID of the API request.", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"messages\": [\n {\n \"content\": [\n {\n \"type\": \"sql\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"user\"\n },\n {\n \"content\": [\n {\n \"type\": \"suggestions\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"user\"\n }\n ],\n \"semantic_model_file\": \"\",\n \"semantic_model\": \"\",\n \"stream\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/cortex/analyst/message", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "cortex", + "analyst", + "message" + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "Unique ID of the API request.", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"messages\": [\n {\n \"content\": [\n {\n \"type\": \"sql\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"user\"\n },\n {\n \"content\": [\n {\n \"type\": \"suggestions\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"user\"\n }\n ],\n \"semantic_model_file\": \"\",\n \"semantic_model\": \"\",\n \"stream\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/cortex/analyst/message", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "cortex", + "analyst", + "message" + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "Unique ID of the API request.", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"messages\": [\n {\n \"content\": [\n {\n \"type\": \"sql\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"user\"\n },\n {\n \"content\": [\n {\n \"type\": \"suggestions\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"user\"\n }\n ],\n \"semantic_model_file\": \"\",\n \"semantic_model\": \"\",\n \"stream\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/cortex/analyst/message", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "cortex", + "analyst", + "message" + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "Unique ID of the API request.", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + } + ] +} \ No newline at end of file diff --git a/public-preview/8.30/collection/Cortex Inference API.postman_collection.json b/public-preview/8.30/collection/Cortex Inference API.postman_collection.json new file mode 100644 index 0000000..bda2551 --- /dev/null +++ b/public-preview/8.30/collection/Cortex Inference API.postman_collection.json @@ -0,0 +1,584 @@ +{ + "info": { + "_postman_id": "8c7639b8-0913-41ab-8291-5c350558eac3", + "name": "Cortex Inference API", + "description": "OpenAPI 3.0 specification for the Cortex REST API\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": "28868798", + "_collection_link": "https://snowflake.postman.co/workspace/SnowApi-PuPr~785f3044-d2f3-4a33-8fea-8707898185ed/collection/28868798-8c7639b8-0913-41ab-8291-5c350558eac3?action=share&source=collection_link&creator=28868798" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "cortex", + "item": [ + { + "name": "inference:complete", + "item": [ + { + "name": "Perform LLM text completion inference.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"model\": \"\",\n \"messages\": [\n {\n \"content\": \"\"\n }\n ],\n \"stream\": false,\n \"temperature\": 0,\n \"top_p\": 1,\n \"max_output_tokens\": 4096\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/cortex/inference:complete", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "cortex", + "inference:complete" + ] + }, + "description": "Perform LLM text completion inference, similar to snowflake.cortex.Complete." + }, + "response": [ + { + "name": "OK", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"model\": \"\",\n \"messages\": [\n {\n \"content\": \"\"\n }\n ],\n \"stream\": false,\n \"temperature\": 0,\n \"top_p\": 1,\n \"max_output_tokens\": 4096\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/cortex/inference:complete", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "cortex", + "inference:complete" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"choices\": [\n {\n \"message\": {\n \"content\": \"\"\n }\n },\n {\n \"message\": {\n \"content\": \"\"\n }\n }\n ],\n \"usage\": {\n \"prompt_tokens\": \"\",\n \"completion_tokens\": \"\",\n \"total_tokens\": \"\"\n }\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"model\": \"\",\n \"messages\": [\n {\n \"content\": \"\"\n }\n ],\n \"stream\": false,\n \"temperature\": 0,\n \"top_p\": 1,\n \"max_output_tokens\": 4096\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/cortex/inference:complete", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "cortex", + "inference:complete" + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "Unique ID of the API request.", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"model\": \"\",\n \"messages\": [\n {\n \"content\": \"\"\n }\n ],\n \"stream\": false,\n \"temperature\": 0,\n \"top_p\": 1,\n \"max_output_tokens\": 4096\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/cortex/inference:complete", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "cortex", + "inference:complete" + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "Unique ID of the API request.", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"model\": \"\",\n \"messages\": [\n {\n \"content\": \"\"\n }\n ],\n \"stream\": false,\n \"temperature\": 0,\n \"top_p\": 1,\n \"max_output_tokens\": 4096\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/cortex/inference:complete", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "cortex", + "inference:complete" + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "Unique ID of the API request.", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"model\": \"\",\n \"messages\": [\n {\n \"content\": \"\"\n }\n ],\n \"stream\": false,\n \"temperature\": 0,\n \"top_p\": 1,\n \"max_output_tokens\": 4096\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/cortex/inference:complete", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "cortex", + "inference:complete" + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "Unique ID of the API request.", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"model\": \"\",\n \"messages\": [\n {\n \"content\": \"\"\n }\n ],\n \"stream\": false,\n \"temperature\": 0,\n \"top_p\": 1,\n \"max_output_tokens\": 4096\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/cortex/inference:complete", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "cortex", + "inference:complete" + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "Unique ID of the API request.", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"model\": \"\",\n \"messages\": [\n {\n \"content\": \"\"\n }\n ],\n \"stream\": false,\n \"temperature\": 0,\n \"top_p\": 1,\n \"max_output_tokens\": 4096\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/cortex/inference:complete", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "cortex", + "inference:complete" + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "Unique ID of the API request.", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"model\": \"\",\n \"messages\": [\n {\n \"content\": \"\"\n }\n ],\n \"stream\": false,\n \"temperature\": 0,\n \"top_p\": 1,\n \"max_output_tokens\": 4096\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/cortex/inference:complete", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "cortex", + "inference:complete" + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "Unique ID of the API request.", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"model\": \"\",\n \"messages\": [\n {\n \"content\": \"\"\n }\n ],\n \"stream\": false,\n \"temperature\": 0,\n \"top_p\": 1,\n \"max_output_tokens\": 4096\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/cortex/inference:complete", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "cortex", + "inference:complete" + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "Unique ID of the API request.", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "variable": [ + { + "key": "baseUrl", + "value": "/" + } + ] +} \ No newline at end of file diff --git a/public-preview/8.30/collection/Cortex Search REST API.postman_collection.json b/public-preview/8.30/collection/Cortex Search REST API.postman_collection.json new file mode 100644 index 0000000..98cb2a3 --- /dev/null +++ b/public-preview/8.30/collection/Cortex Search REST API.postman_collection.json @@ -0,0 +1,801 @@ +{ + "info": { + "_postman_id": "8123d67f-9f51-42e2-9573-8f75d9aed18e", + "name": "Cortex Search REST API", + "description": "OpenAPI 3.0 specification for the Cortex Search REST API\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": "28868798", + "_collection_link": "https://snowflake.postman.co/workspace/SnowApi-PuPr~785f3044-d2f3-4a33-8fea-8707898185ed/collection/28868798-8123d67f-9f51-42e2-9573-8f75d9aed18e?action=share&source=collection_link&creator=28868798" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "databases", + "item": [ + { + "name": "{database}", + "item": [ + { + "name": "schemas", + "item": [ + { + "name": "{schema}", + "item": [ + { + "name": "cortex-search-services", + "item": [ + { + "name": "{service_name}:query", + "item": [ + { + "name": "Query a Cortex Search Service.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"query\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"filter\": {},\n \"limit\": 10,\n \"experimental\": {\n \"ut4\": true,\n \"dolore3\": 37155695.962142885,\n \"incididuntbb9\": -80406148\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/cortex-search-services/{{service_name}}:query", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "cortex-search-services", + "{{service_name}}:query" + ], + "variable": [ + { + "key": "database", + "value": "CEJ", + "description": "(Required) 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": "CEJ", + "description": "(Required) 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": "Query a Cortex Search Service to get search results." + }, + "response": [ + { + "name": "OK", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"query\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"filter\": {},\n \"limit\": 10,\n \"experimental\": {\n \"ut4\": true,\n \"dolore3\": 37155695.962142885,\n \"incididuntbb9\": -80406148\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/cortex-search-services/{{service_name}}:query", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "cortex-search-services", + "{{service_name}}:query" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"results\": [\n {\n \"ipsum_47\": false,\n \"in0a3\": \"in\"\n },\n {\n \"nisie\": false\n }\n ],\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"query\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"filter\": {},\n \"limit\": 10,\n \"experimental\": {\n \"ut4\": true,\n \"dolore3\": 37155695.962142885,\n \"incididuntbb9\": -80406148\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/cortex-search-services/{{service_name}}:query", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "cortex-search-services", + "{{service_name}}:query" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "Unique ID of the API request.", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"query\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"filter\": {},\n \"limit\": 10,\n \"experimental\": {\n \"ut4\": true,\n \"dolore3\": 37155695.962142885,\n \"incididuntbb9\": -80406148\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/cortex-search-services/{{service_name}}:query", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "cortex-search-services", + "{{service_name}}:query" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "Unique ID of the API request.", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"query\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"filter\": {},\n \"limit\": 10,\n \"experimental\": {\n \"ut4\": true,\n \"dolore3\": 37155695.962142885,\n \"incididuntbb9\": -80406148\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/cortex-search-services/{{service_name}}:query", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "cortex-search-services", + "{{service_name}}:query" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "Unique ID of the API request.", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"query\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"filter\": {},\n \"limit\": 10,\n \"experimental\": {\n \"ut4\": true,\n \"dolore3\": 37155695.962142885,\n \"incididuntbb9\": -80406148\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/cortex-search-services/{{service_name}}:query", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "cortex-search-services", + "{{service_name}}:query" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "Unique ID of the API request.", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"query\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"filter\": {},\n \"limit\": 10,\n \"experimental\": {\n \"ut4\": true,\n \"dolore3\": 37155695.962142885,\n \"incididuntbb9\": -80406148\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/cortex-search-services/{{service_name}}:query", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "cortex-search-services", + "{{service_name}}:query" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "Unique ID of the API request.", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"query\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"filter\": {},\n \"limit\": 10,\n \"experimental\": {\n \"ut4\": true,\n \"dolore3\": 37155695.962142885,\n \"incididuntbb9\": -80406148\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/cortex-search-services/{{service_name}}:query", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "cortex-search-services", + "{{service_name}}:query" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "Unique ID of the API request.", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"query\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"filter\": {},\n \"limit\": 10,\n \"experimental\": {\n \"ut4\": true,\n \"dolore3\": 37155695.962142885,\n \"incididuntbb9\": -80406148\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/cortex-search-services/{{service_name}}:query", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "cortex-search-services", + "{{service_name}}:query" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "Unique ID of the API request.", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"query\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"filter\": {},\n \"limit\": 10,\n \"experimental\": {\n \"ut4\": true,\n \"dolore3\": 37155695.962142885,\n \"incididuntbb9\": -80406148\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/cortex-search-services/{{service_name}}:query", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "cortex-search-services", + "{{service_name}}:query" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "Unique ID of the API request.", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"query\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"filter\": {},\n \"limit\": 10,\n \"experimental\": {\n \"ut4\": true,\n \"dolore3\": 37155695.962142885,\n \"incididuntbb9\": -80406148\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/cortex-search-services/{{service_name}}:query", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "cortex-search-services", + "{{service_name}}:query" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "Unique ID of the API request.", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "variable": [ + { + "key": "baseUrl", + "value": "/" + }, + { + "key": "service_name", + "value": "" + } + ] +} \ No newline at end of file diff --git a/public-preview/8.30/collection/Snowflake Compute Pools API.postman_collection.json b/public-preview/8.30/collection/Snowflake Compute Pools API.postman_collection.json new file mode 100644 index 0000000..427ed7d --- /dev/null +++ b/public-preview/8.30/collection/Snowflake Compute Pools API.postman_collection.json @@ -0,0 +1,4906 @@ +{ + "info": { + "_postman_id": "50e91b3b-1f21-4a92-afe6-0712bb930c0f", + "name": "Snowflake Compute Pools API", + "description": "The Snowflake Compute Pools API is a REST API that you can use to access, update, and perform common actions on Compute Pool resources.\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": "28868798", + "_collection_link": "https://snowflake.postman.co/workspace/SnowApi-PuPr~785f3044-d2f3-4a33-8fea-8707898185ed/collection/28868798-50e91b3b-1f21-4a92-afe6-0712bb930c0f?action=share&source=collection_link&creator=28868798" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "compute-pools", + "item": [ + { + "name": "{name}", + "item": [ + { + "name": "Fetches a compute pool.", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "variable": [ + { + "key": "name", + "value": "jYW", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Fetches a named compute pool. You can get the name of the compute pool from the `/api/v2/compute-pools` GET request." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"name\": \"\\\"\\\"\\\"V\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"state\": \"IDLE\",\n \"num_services\": \"\",\n \"auto_suspend_secs\": \"\",\n \"active_nodes\": \"\",\n \"idle_nodes\": \"\",\n \"target_nodes\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"error_code\": \"\",\n \"status_message\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "Deletes a compute pool.", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name", + "value": "jYW", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Deletes a compute pool with the given name. If you enable the `ifExists` parameter, the operation succeeds even if the object does not exist. Otherwise, a 404 failure is returned if the object does not exist." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:resume", + "item": [ + { + "name": "Resumes a suspended compute pool.", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:resume" + ] + }, + "description": "Resume a compute pool, if suspended. If the specified compute pool is already running, no action is taken." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:resume" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:resume" + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:resume" + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:resume" + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:resume" + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:resume" + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:resume" + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:resume" + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:resume" + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:resume" + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:resume" + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:suspend", + "item": [ + { + "name": "Suspends an active compute pool.", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:suspend" + ] + }, + "description": "Suspend a compute pool, if active. If the specified compute pool is already suspended, no action is taken." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:suspend" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:suspend" + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:suspend" + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:suspend" + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:suspend" + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:suspend" + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:suspend" + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:suspend" + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:suspend" + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:suspend" + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:suspend" + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:stopallservices", + "item": [ + { + "name": "Stops all services on the compute pool.", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stopallservices", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stopallservices" + ] + }, + "description": "Stops all services in the compute pool. Deprecated - use :stop-all-services instead." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stopallservices", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stopallservices" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stopallservices", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stopallservices" + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stopallservices", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stopallservices" + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stopallservices", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stopallservices" + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stopallservices", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stopallservices" + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stopallservices", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stopallservices" + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stopallservices", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stopallservices" + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stopallservices", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stopallservices" + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stopallservices", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stopallservices" + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stopallservices", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stopallservices" + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stopallservices", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stopallservices" + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:stop-all-services", + "item": [ + { + "name": "Stops all services on the compute pool.", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stop-all-services", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stop-all-services" + ] + }, + "description": "Stops all services in the compute pool." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stop-all-services", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stop-all-services" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stop-all-services", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stop-all-services" + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stop-all-services", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stop-all-services" + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stop-all-services", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stop-all-services" + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stop-all-services", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stop-all-services" + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stop-all-services", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stop-all-services" + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stop-all-services", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stop-all-services" + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stop-all-services", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stop-all-services" + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stop-all-services", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stop-all-services" + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stop-all-services", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stop-all-services" + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stop-all-services", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stop-all-services" + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "Lists compute pools.", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?like=&startsWith=&showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ] + }, + "description": "Lists the compute pools under the account." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?like=&startsWith=&showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"CEJLO\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"state\": \"SUSPENDED\",\n \"num_services\": \"\",\n \"auto_suspend_secs\": \"\",\n \"active_nodes\": \"\",\n \"idle_nodes\": \"\",\n \"target_nodes\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"error_code\": \"\",\n \"status_message\": \"\"\n },\n {\n \"name\": \"n1\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"state\": \"ACTIVE\",\n \"num_services\": \"\",\n \"auto_suspend_secs\": \"\",\n \"active_nodes\": \"\",\n \"idle_nodes\": \"\",\n \"target_nodes\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"error_code\": \"\",\n \"status_message\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?like=&startsWith=&showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?like=&startsWith=&showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?like=&startsWith=&showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?like=&startsWith=&showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?like=&startsWith=&showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?like=&startsWith=&showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?like=&startsWith=&showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?like=&startsWith=&showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?like=&startsWith=&showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?like=&startsWith=&showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "Creates a compute pool.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"V\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"state\": \"IDLE\",\n \"num_services\": \"\",\n \"auto_suspend_secs\": \"\",\n \"active_nodes\": \"\",\n \"idle_nodes\": \"\",\n \"target_nodes\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"error_code\": \"\",\n \"status_message\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?createMode=errorIfExists&initiallySuspended=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "initiallySuspended", + "value": "", + "description": "Specifies whether the compute pool is created initially in the suspended state." + } + ] + }, + "description": "Creates a compute pool, with standard create modifiers as query parameters. See the Compute Pool component definition for what is required to be provided in the request body." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"V\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"state\": \"IDLE\",\n \"num_services\": \"\",\n \"auto_suspend_secs\": \"\",\n \"active_nodes\": \"\",\n \"idle_nodes\": \"\",\n \"target_nodes\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"error_code\": \"\",\n \"status_message\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?createMode=errorIfExists&initiallySuspended=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "initiallySuspended", + "value": "", + "description": "Specifies whether the compute pool is created initially in the suspended state." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"V\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"state\": \"IDLE\",\n \"num_services\": \"\",\n \"auto_suspend_secs\": \"\",\n \"active_nodes\": \"\",\n \"idle_nodes\": \"\",\n \"target_nodes\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"error_code\": \"\",\n \"status_message\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?createMode=errorIfExists&initiallySuspended=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "initiallySuspended", + "value": "", + "description": "Specifies whether the compute pool is created initially in the suspended state." + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"V\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"state\": \"IDLE\",\n \"num_services\": \"\",\n \"auto_suspend_secs\": \"\",\n \"active_nodes\": \"\",\n \"idle_nodes\": \"\",\n \"target_nodes\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"error_code\": \"\",\n \"status_message\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?createMode=errorIfExists&initiallySuspended=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "initiallySuspended", + "value": "", + "description": "Specifies whether the compute pool is created initially in the suspended state." + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"V\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"state\": \"IDLE\",\n \"num_services\": \"\",\n \"auto_suspend_secs\": \"\",\n \"active_nodes\": \"\",\n \"idle_nodes\": \"\",\n \"target_nodes\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"error_code\": \"\",\n \"status_message\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?createMode=errorIfExists&initiallySuspended=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "initiallySuspended", + "value": "", + "description": "Specifies whether the compute pool is created initially in the suspended state." + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"V\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"state\": \"IDLE\",\n \"num_services\": \"\",\n \"auto_suspend_secs\": \"\",\n \"active_nodes\": \"\",\n \"idle_nodes\": \"\",\n \"target_nodes\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"error_code\": \"\",\n \"status_message\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?createMode=errorIfExists&initiallySuspended=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "initiallySuspended", + "value": "", + "description": "Specifies whether the compute pool is created initially in the suspended state." + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"V\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"state\": \"IDLE\",\n \"num_services\": \"\",\n \"auto_suspend_secs\": \"\",\n \"active_nodes\": \"\",\n \"idle_nodes\": \"\",\n \"target_nodes\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"error_code\": \"\",\n \"status_message\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?createMode=errorIfExists&initiallySuspended=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "initiallySuspended", + "value": "", + "description": "Specifies whether the compute pool is created initially in the suspended state." + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"V\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"state\": \"IDLE\",\n \"num_services\": \"\",\n \"auto_suspend_secs\": \"\",\n \"active_nodes\": \"\",\n \"idle_nodes\": \"\",\n \"target_nodes\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"error_code\": \"\",\n \"status_message\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?createMode=errorIfExists&initiallySuspended=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "initiallySuspended", + "value": "", + "description": "Specifies whether the compute pool is created initially in the suspended state." + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"V\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"state\": \"IDLE\",\n \"num_services\": \"\",\n \"auto_suspend_secs\": \"\",\n \"active_nodes\": \"\",\n \"idle_nodes\": \"\",\n \"target_nodes\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"error_code\": \"\",\n \"status_message\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?createMode=errorIfExists&initiallySuspended=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "initiallySuspended", + "value": "", + "description": "Specifies whether the compute pool is created initially in the suspended state." + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"V\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"state\": \"IDLE\",\n \"num_services\": \"\",\n \"auto_suspend_secs\": \"\",\n \"active_nodes\": \"\",\n \"idle_nodes\": \"\",\n \"target_nodes\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"error_code\": \"\",\n \"status_message\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?createMode=errorIfExists&initiallySuspended=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "initiallySuspended", + "value": "", + "description": "Specifies whether the compute pool is created initially in the suspended state." + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"V\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"state\": \"IDLE\",\n \"num_services\": \"\",\n \"auto_suspend_secs\": \"\",\n \"active_nodes\": \"\",\n \"idle_nodes\": \"\",\n \"target_nodes\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"error_code\": \"\",\n \"status_message\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?createMode=errorIfExists&initiallySuspended=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "initiallySuspended", + "value": "", + "description": "Specifies whether the compute pool is created initially in the suspended state." + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"V\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"state\": \"IDLE\",\n \"num_services\": \"\",\n \"auto_suspend_secs\": \"\",\n \"active_nodes\": \"\",\n \"idle_nodes\": \"\",\n \"target_nodes\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"error_code\": \"\",\n \"status_message\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?createMode=errorIfExists&initiallySuspended=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "initiallySuspended", + "value": "", + "description": "Specifies whether the compute pool is created initially in the suspended state." + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"V\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"state\": \"IDLE\",\n \"num_services\": \"\",\n \"auto_suspend_secs\": \"\",\n \"active_nodes\": \"\",\n \"idle_nodes\": \"\",\n \"target_nodes\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"error_code\": \"\",\n \"status_message\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?createMode=errorIfExists&initiallySuspended=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "initiallySuspended", + "value": "", + "description": "Specifies whether the compute pool is created initially in the suspended state." + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + } + ] + } + ] + } + ], + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + }, + { + "key": "name", + "value": "jYW" + }, + { + "key": "name", + "value": "jYW" + }, + { + "key": "name", + "value": "jYW" + }, + { + "key": "name", + "value": "jYW" + } + ] +} \ No newline at end of file diff --git a/public-preview/8.30/collection/Snowflake Database API.postman_collection.json b/public-preview/8.30/collection/Snowflake Database API.postman_collection.json new file mode 100644 index 0000000..9a21105 --- /dev/null +++ b/public-preview/8.30/collection/Snowflake Database API.postman_collection.json @@ -0,0 +1,11981 @@ +{ + "info": { + "_postman_id": "f2879907-c966-4196-9038-e9de18ec96b4", + "name": "Snowflake Database API", + "description": "The Snowflake Database API is a REST API that you can use to access, update, and perform certain actions on Database resource in Snowflake.\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": "28868798", + "_collection_link": "https://snowflake.postman.co/workspace/SnowApi-PuPr~785f3044-d2f3-4a33-8fea-8707898185ed/collection/28868798-f2879907-c966-4196-9038-e9de18ec96b4?action=share&source=collection_link&creator=28868798" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "databases", + "item": [ + { + "name": "{name}:from_share", + "item": [ + { + "name": "Creates a database from a share.", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:from_share?createMode=errorIfExists&share=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:from_share" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "share", + "value": "", + "description": "ID of the share from which to create the database, in the form \".\"." + } + ] + }, + "description": "Creates a database from a given share." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:from_share?createMode=errorIfExists&share=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:from_share" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "share", + "value": "", + "description": "ID of the share from which to create the database, in the form \".\"." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:from_share?createMode=errorIfExists&share=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:from_share" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "share", + "value": "", + "description": "ID of the share from which to create the database, in the form \".\"." + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:from_share?createMode=errorIfExists&share=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:from_share" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "share", + "value": "", + "description": "ID of the share from which to create the database, in the form \".\"." + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:from_share?createMode=errorIfExists&share=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:from_share" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "share", + "value": "", + "description": "ID of the share from which to create the database, in the form \".\"." + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:from_share?createMode=errorIfExists&share=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:from_share" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "share", + "value": "", + "description": "ID of the share from which to create the database, in the form \".\"." + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:from_share?createMode=errorIfExists&share=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:from_share" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "share", + "value": "", + "description": "ID of the share from which to create the database, in the form \".\"." + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:from_share?createMode=errorIfExists&share=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:from_share" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "share", + "value": "", + "description": "ID of the share from which to create the database, in the form \".\"." + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:from_share?createMode=errorIfExists&share=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:from_share" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "share", + "value": "", + "description": "ID of the share from which to create the database, in the form \".\"." + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:from_share?createMode=errorIfExists&share=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:from_share" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "share", + "value": "", + "description": "ID of the share from which to create the database, in the form \".\"." + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:from_share?createMode=errorIfExists&share=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:from_share" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "share", + "value": "", + "description": "ID of the share from which to create the database, in the form \".\"." + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:from_share?createMode=errorIfExists&share=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:from_share" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "share", + "value": "", + "description": "ID of the share from which to create the database, in the form \".\"." + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:from_share?createMode=errorIfExists&share=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:from_share" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "share", + "value": "", + "description": "ID of the share from which to create the database, in the form \".\"." + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:from_share?createMode=errorIfExists&share=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:from_share" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "share", + "value": "", + "description": "ID of the share from which to create the database, in the form \".\"." + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:clone", + "item": [ + { + "name": "Clones a database.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"8+\\\"\\\"\\\"\\\"\\\"\\\"R\\\"\\\"\\\"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"ut deserunt minim est\",\n \"reference\": \"amet ad cillum sint consectetur\"\n },\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:clone?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of database to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ] + }, + "description": "Clones an existing database, with modifiers as query parameters. You must provide the full database definition when cloning an existing database." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"8+\\\"\\\"\\\"\\\"\\\"\\\"R\\\"\\\"\\\"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"ut deserunt minim est\",\n \"reference\": \"amet ad cillum sint consectetur\"\n },\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:clone?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of database to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"8+\\\"\\\"\\\"\\\"\\\"\\\"R\\\"\\\"\\\"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"ut deserunt minim est\",\n \"reference\": \"amet ad cillum sint consectetur\"\n },\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:clone?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of database to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"8+\\\"\\\"\\\"\\\"\\\"\\\"R\\\"\\\"\\\"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"ut deserunt minim est\",\n \"reference\": \"amet ad cillum sint consectetur\"\n },\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:clone?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of database to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"8+\\\"\\\"\\\"\\\"\\\"\\\"R\\\"\\\"\\\"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"ut deserunt minim est\",\n \"reference\": \"amet ad cillum sint consectetur\"\n },\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:clone?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of database to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"8+\\\"\\\"\\\"\\\"\\\"\\\"R\\\"\\\"\\\"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"ut deserunt minim est\",\n \"reference\": \"amet ad cillum sint consectetur\"\n },\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:clone?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of database to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"8+\\\"\\\"\\\"\\\"\\\"\\\"R\\\"\\\"\\\"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"ut deserunt minim est\",\n \"reference\": \"amet ad cillum sint consectetur\"\n },\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:clone?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of database to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"8+\\\"\\\"\\\"\\\"\\\"\\\"R\\\"\\\"\\\"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"ut deserunt minim est\",\n \"reference\": \"amet ad cillum sint consectetur\"\n },\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:clone?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of database to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"8+\\\"\\\"\\\"\\\"\\\"\\\"R\\\"\\\"\\\"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"ut deserunt minim est\",\n \"reference\": \"amet ad cillum sint consectetur\"\n },\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:clone?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of database to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"8+\\\"\\\"\\\"\\\"\\\"\\\"R\\\"\\\"\\\"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"ut deserunt minim est\",\n \"reference\": \"amet ad cillum sint consectetur\"\n },\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:clone?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of database to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"8+\\\"\\\"\\\"\\\"\\\"\\\"R\\\"\\\"\\\"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"ut deserunt minim est\",\n \"reference\": \"amet ad cillum sint consectetur\"\n },\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:clone?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of database to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"8+\\\"\\\"\\\"\\\"\\\"\\\"R\\\"\\\"\\\"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"ut deserunt minim est\",\n \"reference\": \"amet ad cillum sint consectetur\"\n },\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:clone?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of database to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"8+\\\"\\\"\\\"\\\"\\\"\\\"R\\\"\\\"\\\"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"ut deserunt minim est\",\n \"reference\": \"amet ad cillum sint consectetur\"\n },\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:clone?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of database to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"8+\\\"\\\"\\\"\\\"\\\"\\\"R\\\"\\\"\\\"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"ut deserunt minim est\",\n \"reference\": \"amet ad cillum sint consectetur\"\n },\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:clone?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of database to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}", + "item": [ + { + "name": "replication:enable", + "item": [ + { + "name": "Enables database replication.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:enable?ignore_edition_check=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:enable" + ], + "query": [ + { + "key": "ignore_edition_check", + "value": "", + "description": "Whether to allow replicating data to accounts on lower editions. Default: `true`.\nFor more information, see the ALTER DATABASE reference." + } + ], + "variable": [ + { + "key": "name", + "value": "wrVAnY5bR", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Promotes a local database to serve as a primary database for replication. A primary database can be replicated in one or more accounts, allowing users in those accounts to query objects in each secondary (i.e. replica) database." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:enable?ignore_edition_check=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:enable" + ], + "query": [ + { + "key": "ignore_edition_check", + "value": "", + "description": "Whether to allow replicating data to accounts on lower editions. Default: `true`.\nFor more information, see the ALTER DATABASE reference." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:enable?ignore_edition_check=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:enable" + ], + "query": [ + { + "key": "ignore_edition_check", + "value": "", + "description": "Whether to allow replicating data to accounts on lower editions. Default: `true`.\nFor more information, see the ALTER DATABASE reference." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:enable?ignore_edition_check=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:enable" + ], + "query": [ + { + "key": "ignore_edition_check", + "value": "", + "description": "Whether to allow replicating data to accounts on lower editions. Default: `true`.\nFor more information, see the ALTER DATABASE reference." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:enable?ignore_edition_check=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:enable" + ], + "query": [ + { + "key": "ignore_edition_check", + "value": "", + "description": "Whether to allow replicating data to accounts on lower editions. Default: `true`.\nFor more information, see the ALTER DATABASE reference." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:enable?ignore_edition_check=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:enable" + ], + "query": [ + { + "key": "ignore_edition_check", + "value": "", + "description": "Whether to allow replicating data to accounts on lower editions. Default: `true`.\nFor more information, see the ALTER DATABASE reference." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:enable?ignore_edition_check=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:enable" + ], + "query": [ + { + "key": "ignore_edition_check", + "value": "", + "description": "Whether to allow replicating data to accounts on lower editions. Default: `true`.\nFor more information, see the ALTER DATABASE reference." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:enable?ignore_edition_check=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:enable" + ], + "query": [ + { + "key": "ignore_edition_check", + "value": "", + "description": "Whether to allow replicating data to accounts on lower editions. Default: `true`.\nFor more information, see the ALTER DATABASE reference." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:enable?ignore_edition_check=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:enable" + ], + "query": [ + { + "key": "ignore_edition_check", + "value": "", + "description": "Whether to allow replicating data to accounts on lower editions. Default: `true`.\nFor more information, see the ALTER DATABASE reference." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:enable?ignore_edition_check=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:enable" + ], + "query": [ + { + "key": "ignore_edition_check", + "value": "", + "description": "Whether to allow replicating data to accounts on lower editions. Default: `true`.\nFor more information, see the ALTER DATABASE reference." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:enable?ignore_edition_check=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:enable" + ], + "query": [ + { + "key": "ignore_edition_check", + "value": "", + "description": "Whether to allow replicating data to accounts on lower editions. Default: `true`.\nFor more information, see the ALTER DATABASE reference." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:enable?ignore_edition_check=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:enable" + ], + "query": [ + { + "key": "ignore_edition_check", + "value": "", + "description": "Whether to allow replicating data to accounts on lower editions. Default: `true`.\nFor more information, see the ALTER DATABASE reference." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:enable?ignore_edition_check=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:enable" + ], + "query": [ + { + "key": "ignore_edition_check", + "value": "", + "description": "Whether to allow replicating data to accounts on lower editions. Default: `true`.\nFor more information, see the ALTER DATABASE reference." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:enable?ignore_edition_check=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:enable" + ], + "query": [ + { + "key": "ignore_edition_check", + "value": "", + "description": "Whether to allow replicating data to accounts on lower editions. Default: `true`.\nFor more information, see the ALTER DATABASE reference." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "replication:disable", + "item": [ + { + "name": "Disables database replication.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:disable" + ], + "variable": [ + { + "key": "name", + "value": "wrVAnY5bR", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Disables replication for this primary database, meaning no replica of this database (i.e. secondary database) in another account can be refreshed. Any secondary databases remain linked to the primary database, but requests to refresh a secondary database are denied." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:disable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:disable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:disable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:disable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:disable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:disable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:disable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:disable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:disable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:disable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:disable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:disable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:disable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "replication:refresh", + "item": [ + { + "name": "Refreshes database replications.", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:refresh", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:refresh" + ], + "variable": [ + { + "key": "name", + "value": "wrVAnY5bR", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Refreshes a secondary database from a snapshot of its primary database. A snapshot includes changes to the objects and data.\nIf you call this endpoint while another refresh for the same replica database is running, it fails and returns an error. Snowflake ensures only one refresh is executed at any given time." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:refresh", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:refresh" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:refresh", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:refresh" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:refresh", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:refresh" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:refresh", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:refresh" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:refresh", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:refresh" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:refresh", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:refresh" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:refresh", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:refresh" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:refresh", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:refresh" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:refresh", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:refresh" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:refresh", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:refresh" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:refresh", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:refresh" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:refresh", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:refresh" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:refresh", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:refresh" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "failover:enable", + "item": [ + { + "name": "Enables database failover.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:enable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:enable" + ], + "variable": [ + { + "key": "name", + "value": "wrVAnY5bR", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Specifies a comma-separated list of accounts in your organization where a replica of this primary database can be promoted to serve as the primary database." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:enable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:enable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:enable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:enable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:enable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:enable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:enable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:enable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:enable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:enable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:enable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:enable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:enable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:enable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:enable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:enable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:enable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:enable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:enable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:enable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:enable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:enable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:enable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:enable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:enable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:enable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "failover:disable", + "item": [ + { + "name": "Disables database failover.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:disable" + ], + "variable": [ + { + "key": "name", + "value": "wrVAnY5bR", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Disables failover for this primary database, meaning no replica of this database (i.e. secondary database) can be promoted to serve as the primary database." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:disable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:disable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:disable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:disable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:disable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:disable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:disable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:disable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:disable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:disable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:disable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:disable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"accounts\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:disable", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:disable" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "failover:primary", + "item": [ + { + "name": "Sets a primary database.", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:primary", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:primary" + ], + "variable": [ + { + "key": "name", + "value": "wrVAnY5bR", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Promotes the specified secondary (replica) database to serve as the primary database. When promoted, the database becomes writeable. At the same time, the previous primary database becomes a read-only secondary database." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:primary", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:primary" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:primary", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:primary" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:primary", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:primary" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:primary", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:primary" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:primary", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:primary" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:primary", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:primary" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:primary", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:primary" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:primary", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:primary" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:primary", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:primary" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:primary", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:primary" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:primary", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:primary" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:primary", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:primary" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:primary", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:primary" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "fetch Database", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "variable": [ + { + "key": "name", + "value": "wrVAnY5bR", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Fetches a database." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"name\": \"Pv657gLOx\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "Creates a new, or alters an existing, database.", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Pv657gLOx\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "variable": [ + { + "key": "name", + "value": "wrVAnY5bR", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Creates a new, or alters an existing, database. You must provide the full database definition even when altering an existing database." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Pv657gLOx\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Pv657gLOx\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Pv657gLOx\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Pv657gLOx\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Pv657gLOx\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Pv657gLOx\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Pv657gLOx\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Pv657gLOx\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Pv657gLOx\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Pv657gLOx\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Pv657gLOx\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Pv657gLOx\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Pv657gLOx\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "Deletes a database.", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name?ifExists=false&restrict=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "restrict", + "value": "false", + "description": "Whether to drop the database if foreign keys exist that reference any tables in the database.\n- `true`: Return a warning about existing foreign key references and don't drop the database.\n- `false`: Drop the database and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables." + } + ], + "variable": [ + { + "key": "name", + "value": "wrVAnY5bR", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Deletes the specified database. If you enable the `ifExists` parameter, the operation succeeds even if the database does not exist. Otherwise, a 404 failure is returned if the database does not exist. if the drop is unsuccessful." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name?ifExists=false&restrict=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "restrict", + "value": "false", + "description": "Whether to drop the database if foreign keys exist that reference any tables in the database.\n- `true`: Return a warning about existing foreign key references and don't drop the database.\n- `false`: Drop the database and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name?ifExists=false&restrict=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "restrict", + "value": "false", + "description": "Whether to drop the database if foreign keys exist that reference any tables in the database.\n- `true`: Return a warning about existing foreign key references and don't drop the database.\n- `false`: Drop the database and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name?ifExists=false&restrict=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "restrict", + "value": "false", + "description": "Whether to drop the database if foreign keys exist that reference any tables in the database.\n- `true`: Return a warning about existing foreign key references and don't drop the database.\n- `false`: Drop the database and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name?ifExists=false&restrict=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "restrict", + "value": "false", + "description": "Whether to drop the database if foreign keys exist that reference any tables in the database.\n- `true`: Return a warning about existing foreign key references and don't drop the database.\n- `false`: Drop the database and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name?ifExists=false&restrict=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "restrict", + "value": "false", + "description": "Whether to drop the database if foreign keys exist that reference any tables in the database.\n- `true`: Return a warning about existing foreign key references and don't drop the database.\n- `false`: Drop the database and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name?ifExists=false&restrict=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "restrict", + "value": "false", + "description": "Whether to drop the database if foreign keys exist that reference any tables in the database.\n- `true`: Return a warning about existing foreign key references and don't drop the database.\n- `false`: Drop the database and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name?ifExists=false&restrict=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "restrict", + "value": "false", + "description": "Whether to drop the database if foreign keys exist that reference any tables in the database.\n- `true`: Return a warning about existing foreign key references and don't drop the database.\n- `false`: Drop the database and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name?ifExists=false&restrict=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "restrict", + "value": "false", + "description": "Whether to drop the database if foreign keys exist that reference any tables in the database.\n- `true`: Return a warning about existing foreign key references and don't drop the database.\n- `false`: Drop the database and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name?ifExists=false&restrict=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "restrict", + "value": "false", + "description": "Whether to drop the database if foreign keys exist that reference any tables in the database.\n- `true`: Return a warning about existing foreign key references and don't drop the database.\n- `false`: Drop the database and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name?ifExists=false&restrict=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "restrict", + "value": "false", + "description": "Whether to drop the database if foreign keys exist that reference any tables in the database.\n- `true`: Return a warning about existing foreign key references and don't drop the database.\n- `false`: Drop the database and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name?ifExists=false&restrict=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "restrict", + "value": "false", + "description": "Whether to drop the database if foreign keys exist that reference any tables in the database.\n- `true`: Return a warning about existing foreign key references and don't drop the database.\n- `false`: Drop the database and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name?ifExists=false&restrict=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "restrict", + "value": "false", + "description": "Whether to drop the database if foreign keys exist that reference any tables in the database.\n- `true`: Return a warning about existing foreign key references and don't drop the database.\n- `false`: Drop the database and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name?ifExists=false&restrict=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "restrict", + "value": "false", + "description": "Whether to drop the database if foreign keys exist that reference any tables in the database.\n- `true`: Return a warning about existing foreign key references and don't drop the database.\n- `false`: Drop the database and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "Lists databases.", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases?like=&startsWith=&showLimit=&fromName=&history=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "", + "description": "Optionally includes dropped databases that have not yet been purged." + } + ] + }, + "description": "Lists the accessible databases." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases?like=&startsWith=&showLimit=&fromName=&history=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "", + "description": "Optionally includes dropped databases that have not yet been purged." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"\\\"=\\\"\\\"\\\"\\\"SL\\\"\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n },\n {\n \"name\": \"K14UlR\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases?like=&startsWith=&showLimit=&fromName=&history=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "", + "description": "Optionally includes dropped databases that have not yet been purged." + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases?like=&startsWith=&showLimit=&fromName=&history=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "", + "description": "Optionally includes dropped databases that have not yet been purged." + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases?like=&startsWith=&showLimit=&fromName=&history=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "", + "description": "Optionally includes dropped databases that have not yet been purged." + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases?like=&startsWith=&showLimit=&fromName=&history=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "", + "description": "Optionally includes dropped databases that have not yet been purged." + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases?like=&startsWith=&showLimit=&fromName=&history=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "", + "description": "Optionally includes dropped databases that have not yet been purged." + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases?like=&startsWith=&showLimit=&fromName=&history=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "", + "description": "Optionally includes dropped databases that have not yet been purged." + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases?like=&startsWith=&showLimit=&fromName=&history=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "", + "description": "Optionally includes dropped databases that have not yet been purged." + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases?like=&startsWith=&showLimit=&fromName=&history=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "", + "description": "Optionally includes dropped databases that have not yet been purged." + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases?like=&startsWith=&showLimit=&fromName=&history=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "", + "description": "Optionally includes dropped databases that have not yet been purged." + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases?like=&startsWith=&showLimit=&fromName=&history=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "", + "description": "Optionally includes dropped databases that have not yet been purged." + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases?like=&startsWith=&showLimit=&fromName=&history=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "", + "description": "Optionally includes dropped databases that have not yet been purged." + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases?like=&startsWith=&showLimit=&fromName=&history=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "", + "description": "Optionally includes dropped databases that have not yet been purged." + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "Creates a database.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Pv657gLOx\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of database to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ] + }, + "description": "Creates a database, with modifiers as query parameters. You must provide the full database definition when creating a database." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Pv657gLOx\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of database to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Pv657gLOx\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of database to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Pv657gLOx\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of database to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Pv657gLOx\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of database to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Pv657gLOx\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of database to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Pv657gLOx\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of database to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Pv657gLOx\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of database to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Pv657gLOx\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of database to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Pv657gLOx\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of database to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Pv657gLOx\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of database to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Pv657gLOx\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of database to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Pv657gLOx\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of database to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Pv657gLOx\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"origin\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"budget\": \"\",\n \"owner_role_type\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of database to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "databases:from-share", + "item": [ + { + "name": "Creates a database from a share.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"ysNk05\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases:from-share?createMode=errorIfExists&share=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases:from-share" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "share", + "value": "", + "description": "ID of the share from which to create the database, in the form \".\"." + } + ] + }, + "description": "Creates a database from a given share." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"ysNk05\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases:from-share?createMode=errorIfExists&share=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases:from-share" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "share", + "value": "", + "description": "ID of the share from which to create the database, in the form \".\"." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"ysNk05\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases:from-share?createMode=errorIfExists&share=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases:from-share" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "share", + "value": "", + "description": "ID of the share from which to create the database, in the form \".\"." + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"ysNk05\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases:from-share?createMode=errorIfExists&share=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases:from-share" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "share", + "value": "", + "description": "ID of the share from which to create the database, in the form \".\"." + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"ysNk05\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases:from-share?createMode=errorIfExists&share=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases:from-share" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "share", + "value": "", + "description": "ID of the share from which to create the database, in the form \".\"." + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"ysNk05\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases:from-share?createMode=errorIfExists&share=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases:from-share" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "share", + "value": "", + "description": "ID of the share from which to create the database, in the form \".\"." + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"ysNk05\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases:from-share?createMode=errorIfExists&share=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases:from-share" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "share", + "value": "", + "description": "ID of the share from which to create the database, in the form \".\"." + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"ysNk05\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases:from-share?createMode=errorIfExists&share=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases:from-share" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "share", + "value": "", + "description": "ID of the share from which to create the database, in the form \".\"." + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"ysNk05\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases:from-share?createMode=errorIfExists&share=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases:from-share" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "share", + "value": "", + "description": "ID of the share from which to create the database, in the form \".\"." + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"ysNk05\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases:from-share?createMode=errorIfExists&share=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases:from-share" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "share", + "value": "", + "description": "ID of the share from which to create the database, in the form \".\"." + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"ysNk05\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases:from-share?createMode=errorIfExists&share=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases:from-share" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "share", + "value": "", + "description": "ID of the share from which to create the database, in the form \".\"." + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"ysNk05\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases:from-share?createMode=errorIfExists&share=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases:from-share" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "share", + "value": "", + "description": "ID of the share from which to create the database, in the form \".\"." + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"ysNk05\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases:from-share?createMode=errorIfExists&share=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases:from-share" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "share", + "value": "", + "description": "ID of the share from which to create the database, in the form \".\"." + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"ysNk05\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases:from-share?createMode=errorIfExists&share=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases:from-share" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "share", + "value": "", + "description": "ID of the share from which to create the database, in the form \".\"." + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + } + ] + } + ] + } + ], + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + }, + { + "key": "name", + "value": "wrVAnY5bR" + }, + { + "key": "name", + "value": "wrVAnY5bR" + } + ] +} \ No newline at end of file diff --git a/public-preview/8.30/collection/Snowflake Dynamic Table API.postman_collection.json b/public-preview/8.30/collection/Snowflake Dynamic Table API.postman_collection.json new file mode 100644 index 0000000..20e6063 --- /dev/null +++ b/public-preview/8.30/collection/Snowflake Dynamic Table API.postman_collection.json @@ -0,0 +1,11314 @@ +{ + "info": { + "_postman_id": "0ec5a847-4526-48c8-bdd4-f2ffe44318ee", + "name": "Snowflake Dynamic Table API", + "description": "The Snowflake Dynamic Table API is a REST API that you can use to access, update, and perform certain actions on Dynamic Tables 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": "28868798", + "_collection_link": "https://snowflake.postman.co/workspace/SnowApi-PuPr~785f3044-d2f3-4a33-8fea-8707898185ed/collection/28868798-0ec5a847-4526-48c8-bdd4-f2ffe44318ee?action=share&source=collection_link&creator=28868798" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "databases", + "item": [ + { + "name": "{database}", + "item": [ + { + "name": "schemas", + "item": [ + { + "name": "{schema}", + "item": [ + { + "name": "dynamic-tables", + "item": [ + { + "name": "{name}", + "item": [ + { + "name": "Fetch a dynamic table.", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + ":name" + ], + "variable": [ + { + "key": "database", + "value": "ye$tmz", + "description": "(Required) 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": "ye$tmz", + "description": "(Required) 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": "ye$tmz", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Fetch a Dynamic Table." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"name\": \"\",\n \"target_lag\": {\n \"type\": \"\"\n },\n \"warehouse\": \"\",\n \"query\": \"\",\n \"kind\": \"PERMANENT\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n }\n ],\n \"refresh_mode\": \"INCREMENTAL\",\n \"initialize\": \"ON_SCHEDULE\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"scheduling_state\": \"RUNNING\",\n \"automatic_clustering\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "Delete a dynamic table", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database", + "value": "ye$tmz", + "description": "(Required) 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": "ye$tmz", + "description": "(Required) 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": "ye$tmz", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Delete a dynamic table 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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:clone", + "item": [ + { + "name": "Clone dynamic table", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"target_lag\": {\n \"type\": \"\"\n },\n \"warehouse\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"\",\n \"reference\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=ye$tmz&targetSchema=ye$tmz", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "targetDatabase", + "value": "ye$tmz", + "description": "Database of the newly created dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "ye$tmz", + "description": "Schema of the newly created dynamic table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database", + "value": "ye$tmz", + "description": "(Required) 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": "ye$tmz", + "description": "(Required) 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 new dynamic table by cloning from the specified resource" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"target_lag\": {\n \"type\": \"\"\n },\n \"warehouse\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"\",\n \"reference\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=ye$tmz&targetSchema=ye$tmz", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "targetDatabase", + "value": "ye$tmz", + "description": "Database of the newly created dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "ye$tmz", + "description": "Schema of the newly created dynamic table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"target_lag\": {\n \"type\": \"\"\n },\n \"warehouse\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"\",\n \"reference\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=ye$tmz&targetSchema=ye$tmz", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "targetDatabase", + "value": "ye$tmz", + "description": "Database of the newly created dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "ye$tmz", + "description": "Schema of the newly created dynamic table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"target_lag\": {\n \"type\": \"\"\n },\n \"warehouse\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"\",\n \"reference\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=ye$tmz&targetSchema=ye$tmz", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "targetDatabase", + "value": "ye$tmz", + "description": "Database of the newly created dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "ye$tmz", + "description": "Schema of the newly created dynamic table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"target_lag\": {\n \"type\": \"\"\n },\n \"warehouse\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"\",\n \"reference\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=ye$tmz&targetSchema=ye$tmz", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "targetDatabase", + "value": "ye$tmz", + "description": "Database of the newly created dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "ye$tmz", + "description": "Schema of the newly created dynamic table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"target_lag\": {\n \"type\": \"\"\n },\n \"warehouse\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"\",\n \"reference\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=ye$tmz&targetSchema=ye$tmz", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "targetDatabase", + "value": "ye$tmz", + "description": "Database of the newly created dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "ye$tmz", + "description": "Schema of the newly created dynamic table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"target_lag\": {\n \"type\": \"\"\n },\n \"warehouse\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"\",\n \"reference\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=ye$tmz&targetSchema=ye$tmz", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "targetDatabase", + "value": "ye$tmz", + "description": "Database of the newly created dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "ye$tmz", + "description": "Schema of the newly created dynamic table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"target_lag\": {\n \"type\": \"\"\n },\n \"warehouse\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"\",\n \"reference\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=ye$tmz&targetSchema=ye$tmz", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "targetDatabase", + "value": "ye$tmz", + "description": "Database of the newly created dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "ye$tmz", + "description": "Schema of the newly created dynamic table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"target_lag\": {\n \"type\": \"\"\n },\n \"warehouse\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"\",\n \"reference\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=ye$tmz&targetSchema=ye$tmz", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "targetDatabase", + "value": "ye$tmz", + "description": "Database of the newly created dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "ye$tmz", + "description": "Schema of the newly created dynamic table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"target_lag\": {\n \"type\": \"\"\n },\n \"warehouse\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"\",\n \"reference\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=ye$tmz&targetSchema=ye$tmz", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "targetDatabase", + "value": "ye$tmz", + "description": "Database of the newly created dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "ye$tmz", + "description": "Schema of the newly created dynamic table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"target_lag\": {\n \"type\": \"\"\n },\n \"warehouse\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"\",\n \"reference\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=ye$tmz&targetSchema=ye$tmz", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "targetDatabase", + "value": "ye$tmz", + "description": "Database of the newly created dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "ye$tmz", + "description": "Schema of the newly created dynamic table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"target_lag\": {\n \"type\": \"\"\n },\n \"warehouse\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"\",\n \"reference\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=ye$tmz&targetSchema=ye$tmz", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "targetDatabase", + "value": "ye$tmz", + "description": "Database of the newly created dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "ye$tmz", + "description": "Schema of the newly created dynamic table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"target_lag\": {\n \"type\": \"\"\n },\n \"warehouse\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"\",\n \"reference\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=ye$tmz&targetSchema=ye$tmz", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "targetDatabase", + "value": "ye$tmz", + "description": "Database of the newly created dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "ye$tmz", + "description": "Schema of the newly created dynamic table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"target_lag\": {\n \"type\": \"\"\n },\n \"warehouse\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"\",\n \"reference\": \"\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=ye$tmz&targetSchema=ye$tmz", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "targetDatabase", + "value": "ye$tmz", + "description": "Database of the newly created dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "ye$tmz", + "description": "Schema of the newly created dynamic table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:undrop", + "item": [ + { + "name": "Undrop a dynamic table", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database", + "value": "ye$tmz", + "description": "(Required) 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": "ye$tmz", + "description": "(Required) 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": "Undrop specified dynamic table" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:suspend", + "item": [ + { + "name": "Suspend refreshes on the dynamic table", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database", + "value": "ye$tmz", + "description": "(Required) 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": "ye$tmz", + "description": "(Required) 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 refreshes on the dynamic table" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:resume", + "item": [ + { + "name": "Resume refreshes on the dynamic table", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database", + "value": "ye$tmz", + "description": "(Required) 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": "ye$tmz", + "description": "(Required) 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 refreshes on the dynamic table" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:refresh", + "item": [ + { + "name": "Refresh the dynamic table", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:refresh?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:refresh" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database", + "value": "ye$tmz", + "description": "(Required) 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": "ye$tmz", + "description": "(Required) 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": "Specifies that the dynamic table should be manually refreshed" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:refresh?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:refresh" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:refresh?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:refresh" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:refresh?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:refresh" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:refresh?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:refresh" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:refresh?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:refresh" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:refresh?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:refresh" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:refresh?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:refresh" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:refresh?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:refresh" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:refresh?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:refresh" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:refresh?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:refresh" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:refresh?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:refresh" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:refresh?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:refresh" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:refresh?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:refresh" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:suspend-recluster", + "item": [ + { + "name": "Suspend recluster of a dynamic table", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:suspend-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:suspend-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database", + "value": "ye$tmz", + "description": "(Required) 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": "ye$tmz", + "description": "(Required) 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 recluster of a dynamic table" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:suspend-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:suspend-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:suspend-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:suspend-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:suspend-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:suspend-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:suspend-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:suspend-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:suspend-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:suspend-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:suspend-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:suspend-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:suspend-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:suspend-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:suspend-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:suspend-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:suspend-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:suspend-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:suspend-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:suspend-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:suspend-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:suspend-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:suspend-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:suspend-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:suspend-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:suspend-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:resume-recluster", + "item": [ + { + "name": "Resume recluster of a dynamic table", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:resume-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:resume-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database", + "value": "ye$tmz", + "description": "(Required) 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": "ye$tmz", + "description": "(Required) 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 recluster of a dynamic table" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:resume-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:resume-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:resume-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:resume-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:resume-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:resume-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:resume-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:resume-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:resume-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:resume-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:resume-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:resume-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:resume-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:resume-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:resume-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:resume-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:resume-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:resume-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:resume-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:resume-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:resume-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:resume-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:resume-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:resume-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:resume-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:resume-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:swap-with", + "item": [ + { + "name": "Swap with another dynamic table", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:swap-with?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:swap-with" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetName", + "value": "", + "description": "(Required) The fully-specified name of the target dynamic table to be swapped with." + } + ], + "variable": [ + { + "key": "database", + "value": "ye$tmz", + "description": "(Required) 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": "ye$tmz", + "description": "(Required) 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": "Swap with another dynamic table" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:swap-with?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:swap-with" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetName", + "value": "", + "description": "(Required) The fully-specified name of the target dynamic table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:swap-with?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:swap-with" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetName", + "value": "", + "description": "(Required) The fully-specified name of the target dynamic table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:swap-with?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:swap-with" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetName", + "value": "", + "description": "(Required) The fully-specified name of the target dynamic table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:swap-with?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:swap-with" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetName", + "value": "", + "description": "(Required) The fully-specified name of the target dynamic table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:swap-with?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:swap-with" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetName", + "value": "", + "description": "(Required) The fully-specified name of the target dynamic table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:swap-with?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:swap-with" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetName", + "value": "", + "description": "(Required) The fully-specified name of the target dynamic table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:swap-with?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:swap-with" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetName", + "value": "", + "description": "(Required) The fully-specified name of the target dynamic table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:swap-with?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:swap-with" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetName", + "value": "", + "description": "(Required) The fully-specified name of the target dynamic table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:swap-with?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:swap-with" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetName", + "value": "", + "description": "(Required) The fully-specified name of the target dynamic table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:swap-with?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:swap-with" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetName", + "value": "", + "description": "(Required) The fully-specified name of the target dynamic table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:swap-with?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:swap-with" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetName", + "value": "", + "description": "(Required) The fully-specified name of the target dynamic table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:swap-with?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:swap-with" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetName", + "value": "", + "description": "(Required) The fully-specified name of the target dynamic table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:swap-with?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables", + "{{name}}:swap-with" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetName", + "value": "", + "description": "(Required) The fully-specified name of the target dynamic table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "List dynamic tables", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables?like=&startsWith=&showLimit=&fromName=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "deep", + "value": "", + "description": "Optionally includes dependency information of the dynamic table." + } + ], + "variable": [ + { + "key": "database", + "value": "ye$tmz", + "description": "(Required) 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": "ye$tmz", + "description": "(Required) 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 dynamic tables under the database and schema." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables?like=&startsWith=&showLimit=&fromName=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "deep", + "value": "", + "description": "Optionally includes dependency information of the dynamic table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"\",\n \"target_lag\": {\n \"type\": \"\"\n },\n \"warehouse\": \"\",\n \"query\": \"\",\n \"kind\": \"PERMANENT\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n }\n ],\n \"refresh_mode\": \"FULL\",\n \"initialize\": \"ON_CREATE\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"scheduling_state\": \"SUSPENDED\",\n \"automatic_clustering\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n },\n {\n \"name\": \"\",\n \"target_lag\": {\n \"type\": \"\"\n },\n \"warehouse\": \"\",\n \"query\": \"\",\n \"kind\": \"PERMANENT\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n }\n ],\n \"refresh_mode\": \"FULL\",\n \"initialize\": \"ON_SCHEDULE\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"scheduling_state\": \"RUNNING\",\n \"automatic_clustering\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables?like=&startsWith=&showLimit=&fromName=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "deep", + "value": "", + "description": "Optionally includes dependency information of the dynamic table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables?like=&startsWith=&showLimit=&fromName=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "deep", + "value": "", + "description": "Optionally includes dependency information of the dynamic table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables?like=&startsWith=&showLimit=&fromName=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "deep", + "value": "", + "description": "Optionally includes dependency information of the dynamic table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables?like=&startsWith=&showLimit=&fromName=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "deep", + "value": "", + "description": "Optionally includes dependency information of the dynamic table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables?like=&startsWith=&showLimit=&fromName=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "deep", + "value": "", + "description": "Optionally includes dependency information of the dynamic table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables?like=&startsWith=&showLimit=&fromName=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "deep", + "value": "", + "description": "Optionally includes dependency information of the dynamic table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables?like=&startsWith=&showLimit=&fromName=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "deep", + "value": "", + "description": "Optionally includes dependency information of the dynamic table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables?like=&startsWith=&showLimit=&fromName=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "deep", + "value": "", + "description": "Optionally includes dependency information of the dynamic table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables?like=&startsWith=&showLimit=&fromName=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "deep", + "value": "", + "description": "Optionally includes dependency information of the dynamic table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables?like=&startsWith=&showLimit=&fromName=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "deep", + "value": "", + "description": "Optionally includes dependency information of the dynamic table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables?like=&startsWith=&showLimit=&fromName=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "deep", + "value": "", + "description": "Optionally includes dependency information of the dynamic table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables?like=&startsWith=&showLimit=&fromName=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "deep", + "value": "", + "description": "Optionally includes dependency information of the dynamic table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "Create a dynamic table", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"target_lag\": {\n \"type\": \"\"\n },\n \"warehouse\": \"\",\n \"query\": \"\",\n \"kind\": \"PERMANENT\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n }\n ],\n \"refresh_mode\": \"INCREMENTAL\",\n \"initialize\": \"ON_SCHEDULE\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"scheduling_state\": \"RUNNING\",\n \"automatic_clustering\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database", + "value": "ye$tmz", + "description": "(Required) 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": "ye$tmz", + "description": "(Required) 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 dynamic table, with standard create modifiers as query parameters. See the Dynamic Table 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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"target_lag\": {\n \"type\": \"\"\n },\n \"warehouse\": \"\",\n \"query\": \"\",\n \"kind\": \"PERMANENT\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n }\n ],\n \"refresh_mode\": \"INCREMENTAL\",\n \"initialize\": \"ON_SCHEDULE\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"scheduling_state\": \"RUNNING\",\n \"automatic_clustering\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"target_lag\": {\n \"type\": \"\"\n },\n \"warehouse\": \"\",\n \"query\": \"\",\n \"kind\": \"PERMANENT\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n }\n ],\n \"refresh_mode\": \"INCREMENTAL\",\n \"initialize\": \"ON_SCHEDULE\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"scheduling_state\": \"RUNNING\",\n \"automatic_clustering\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"target_lag\": {\n \"type\": \"\"\n },\n \"warehouse\": \"\",\n \"query\": \"\",\n \"kind\": \"PERMANENT\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n }\n ],\n \"refresh_mode\": \"INCREMENTAL\",\n \"initialize\": \"ON_SCHEDULE\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"scheduling_state\": \"RUNNING\",\n \"automatic_clustering\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"target_lag\": {\n \"type\": \"\"\n },\n \"warehouse\": \"\",\n \"query\": \"\",\n \"kind\": \"PERMANENT\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n }\n ],\n \"refresh_mode\": \"INCREMENTAL\",\n \"initialize\": \"ON_SCHEDULE\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"scheduling_state\": \"RUNNING\",\n \"automatic_clustering\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"target_lag\": {\n \"type\": \"\"\n },\n \"warehouse\": \"\",\n \"query\": \"\",\n \"kind\": \"PERMANENT\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n }\n ],\n \"refresh_mode\": \"INCREMENTAL\",\n \"initialize\": \"ON_SCHEDULE\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"scheduling_state\": \"RUNNING\",\n \"automatic_clustering\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"target_lag\": {\n \"type\": \"\"\n },\n \"warehouse\": \"\",\n \"query\": \"\",\n \"kind\": \"PERMANENT\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n }\n ],\n \"refresh_mode\": \"INCREMENTAL\",\n \"initialize\": \"ON_SCHEDULE\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"scheduling_state\": \"RUNNING\",\n \"automatic_clustering\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"target_lag\": {\n \"type\": \"\"\n },\n \"warehouse\": \"\",\n \"query\": \"\",\n \"kind\": \"PERMANENT\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n }\n ],\n \"refresh_mode\": \"INCREMENTAL\",\n \"initialize\": \"ON_SCHEDULE\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"scheduling_state\": \"RUNNING\",\n \"automatic_clustering\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"target_lag\": {\n \"type\": \"\"\n },\n \"warehouse\": \"\",\n \"query\": \"\",\n \"kind\": \"PERMANENT\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n }\n ],\n \"refresh_mode\": \"INCREMENTAL\",\n \"initialize\": \"ON_SCHEDULE\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"scheduling_state\": \"RUNNING\",\n \"automatic_clustering\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"target_lag\": {\n \"type\": \"\"\n },\n \"warehouse\": \"\",\n \"query\": \"\",\n \"kind\": \"PERMANENT\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n }\n ],\n \"refresh_mode\": \"INCREMENTAL\",\n \"initialize\": \"ON_SCHEDULE\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"scheduling_state\": \"RUNNING\",\n \"automatic_clustering\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"target_lag\": {\n \"type\": \"\"\n },\n \"warehouse\": \"\",\n \"query\": \"\",\n \"kind\": \"PERMANENT\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n }\n ],\n \"refresh_mode\": \"INCREMENTAL\",\n \"initialize\": \"ON_SCHEDULE\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"scheduling_state\": \"RUNNING\",\n \"automatic_clustering\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"target_lag\": {\n \"type\": \"\"\n },\n \"warehouse\": \"\",\n \"query\": \"\",\n \"kind\": \"PERMANENT\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n }\n ],\n \"refresh_mode\": \"INCREMENTAL\",\n \"initialize\": \"ON_SCHEDULE\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"scheduling_state\": \"RUNNING\",\n \"automatic_clustering\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"target_lag\": {\n \"type\": \"\"\n },\n \"warehouse\": \"\",\n \"query\": \"\",\n \"kind\": \"PERMANENT\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n }\n ],\n \"refresh_mode\": \"INCREMENTAL\",\n \"initialize\": \"ON_SCHEDULE\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"scheduling_state\": \"RUNNING\",\n \"automatic_clustering\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"target_lag\": {\n \"type\": \"\"\n },\n \"warehouse\": \"\",\n \"query\": \"\",\n \"kind\": \"PERMANENT\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"comment\": \"\"\n }\n ],\n \"refresh_mode\": \"INCREMENTAL\",\n \"initialize\": \"ON_SCHEDULE\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"scheduling_state\": \"RUNNING\",\n \"automatic_clustering\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "dynamic-tables" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + }, + { + "key": "name", + "value": "ye$tmz" + }, + { + "key": "name", + "value": "ye$tmz" + }, + { + "key": "name", + "value": "ye$tmz" + }, + { + "key": "name", + "value": "ye$tmz" + }, + { + "key": "name", + "value": "ye$tmz" + }, + { + "key": "name", + "value": "ye$tmz" + }, + { + "key": "name", + "value": "ye$tmz" + }, + { + "key": "name", + "value": "ye$tmz" + } + ] +} \ No newline at end of file diff --git a/public-preview/8.30/collection/Snowflake Function API.postman_collection.json b/public-preview/8.30/collection/Snowflake Function API.postman_collection.json new file mode 100644 index 0000000..2f07ed9 --- /dev/null +++ b/public-preview/8.30/collection/Snowflake Function API.postman_collection.json @@ -0,0 +1,4062 @@ +{ + "info": { + "_postman_id": "581eb076-ee9d-4ce1-a743-bfeb1a84f375", + "name": "Snowflake Function API", + "description": "The Snowflake Function API is a REST API that allows caller to create, execute and drop functions 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": "28868798", + "_collection_link": "https://snowflake.postman.co/workspace/SnowApi-PuPr~785f3044-d2f3-4a33-8fea-8707898185ed/collection/28868798-581eb076-ee9d-4ce1-a743-bfeb1a84f375?action=share&source=collection_link&creator=28868798" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "databases", + "item": [ + { + "name": "{database}", + "item": [ + { + "name": "schemas", + "item": [ + { + "name": "{schema}", + "item": [ + { + "name": "functions", + "item": [ + { + "name": "{nameWithArgs}", + "item": [ + { + "name": "Fetch a Function.", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + ":nameWithArgs" + ], + "variable": [ + { + "key": "database", + "value": "hpXyfrqcY", + "description": "(Required) 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": "hpXyfrqcY", + "description": "(Required) 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": "nameWithArgs", + "value": "", + "description": "(Required) Function's name with Args" + } + ] + }, + "description": "Fetch a Function using the describe command output." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + ":nameWithArgs" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "nameWithArgs" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"name\": \"\",\n \"arguments\": [\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n },\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n }\n ],\n \"function_type\": \"service-function\",\n \"returns\": \"TEXT\",\n \"max_batch_rows\": \"\",\n \"created_on\": \"\",\n \"signature\": \"\",\n \"language\": \"\",\n \"body\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + ":nameWithArgs" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "nameWithArgs" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + ":nameWithArgs" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "nameWithArgs" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + ":nameWithArgs" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "nameWithArgs" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + ":nameWithArgs" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "nameWithArgs" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + ":nameWithArgs" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "nameWithArgs" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + ":nameWithArgs" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "nameWithArgs" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + ":nameWithArgs" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "nameWithArgs" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + ":nameWithArgs" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "nameWithArgs" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + ":nameWithArgs" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "nameWithArgs" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + ":nameWithArgs" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "nameWithArgs" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "Delete a function", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + ":nameWithArgs" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database", + "value": "hpXyfrqcY", + "description": "(Required) 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": "hpXyfrqcY", + "description": "(Required) 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": "nameWithArgs", + "value": "", + "description": "(Required) Function's name with Args" + } + ] + }, + "description": "Delete a function with the given name and args." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + ":nameWithArgs" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "nameWithArgs" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + ":nameWithArgs" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "nameWithArgs" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + ":nameWithArgs" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "nameWithArgs" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + ":nameWithArgs" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "nameWithArgs" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + ":nameWithArgs" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "nameWithArgs" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + ":nameWithArgs" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "nameWithArgs" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + ":nameWithArgs" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "nameWithArgs" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + ":nameWithArgs" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "nameWithArgs" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + ":nameWithArgs" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "nameWithArgs" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + ":nameWithArgs" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "nameWithArgs" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + ":nameWithArgs" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "nameWithArgs" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:execute", + "item": [ + { + "name": "Execute a Function.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n },\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/{{name}}:execute", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + "{{name}}:execute" + ], + "variable": [ + { + "key": "database", + "value": "hpXyfrqcY", + "description": "(Required) 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": "hpXyfrqcY", + "description": "(Required) 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": "Execute a Function." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n },\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/{{name}}:execute", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + "{{name}}:execute" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{}" + }, + { + "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" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n },\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/{{name}}:execute", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + "{{name}}:execute" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n },\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/{{name}}:execute", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + "{{name}}:execute" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n },\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/{{name}}:execute", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + "{{name}}:execute" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n },\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/{{name}}:execute", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + "{{name}}:execute" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n },\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/{{name}}:execute", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + "{{name}}:execute" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n },\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/{{name}}:execute", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + "{{name}}:execute" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n },\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/{{name}}:execute", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + "{{name}}:execute" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n },\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/{{name}}:execute", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + "{{name}}:execute" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n },\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/{{name}}:execute", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + "{{name}}:execute" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "[\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n },\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n }\n]", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions/{{name}}:execute", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions", + "{{name}}:execute" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "List Functions", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database", + "value": "hpXyfrqcY", + "description": "(Required) 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": "hpXyfrqcY", + "description": "(Required) 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 user functions under the database and schema." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"\",\n \"arguments\": [\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n },\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n }\n ],\n \"function_type\": \"service-function\",\n \"returns\": \"TEXT\",\n \"max_batch_rows\": \"\",\n \"created_on\": \"\",\n \"signature\": \"\",\n \"language\": \"\",\n \"body\": \"\"\n },\n {\n \"name\": \"\",\n \"arguments\": [\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n },\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n }\n ],\n \"function_type\": \"service-function\",\n \"returns\": \"TEXT\",\n \"max_batch_rows\": \"\",\n \"created_on\": \"\",\n \"signature\": \"\",\n \"language\": \"\",\n \"body\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "Create a Function", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"arguments\": [\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n },\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n }\n ],\n \"function_type\": \"service-function\",\n \"returns\": \"TEXT\",\n \"max_batch_rows\": \"\",\n \"created_on\": \"\",\n \"signature\": \"\",\n \"language\": \"\",\n \"body\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database", + "value": "hpXyfrqcY", + "description": "(Required) 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": "hpXyfrqcY", + "description": "(Required) 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 function." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"arguments\": [\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n },\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n }\n ],\n \"function_type\": \"service-function\",\n \"returns\": \"TEXT\",\n \"max_batch_rows\": \"\",\n \"created_on\": \"\",\n \"signature\": \"\",\n \"language\": \"\",\n \"body\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"arguments\": [\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n },\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n }\n ],\n \"function_type\": \"service-function\",\n \"returns\": \"TEXT\",\n \"max_batch_rows\": \"\",\n \"created_on\": \"\",\n \"signature\": \"\",\n \"language\": \"\",\n \"body\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"arguments\": [\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n },\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n }\n ],\n \"function_type\": \"service-function\",\n \"returns\": \"TEXT\",\n \"max_batch_rows\": \"\",\n \"created_on\": \"\",\n \"signature\": \"\",\n \"language\": \"\",\n \"body\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"arguments\": [\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n },\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n }\n ],\n \"function_type\": \"service-function\",\n \"returns\": \"TEXT\",\n \"max_batch_rows\": \"\",\n \"created_on\": \"\",\n \"signature\": \"\",\n \"language\": \"\",\n \"body\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"arguments\": [\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n },\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n }\n ],\n \"function_type\": \"service-function\",\n \"returns\": \"TEXT\",\n \"max_batch_rows\": \"\",\n \"created_on\": \"\",\n \"signature\": \"\",\n \"language\": \"\",\n \"body\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"arguments\": [\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n },\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n }\n ],\n \"function_type\": \"service-function\",\n \"returns\": \"TEXT\",\n \"max_batch_rows\": \"\",\n \"created_on\": \"\",\n \"signature\": \"\",\n \"language\": \"\",\n \"body\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"arguments\": [\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n },\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n }\n ],\n \"function_type\": \"service-function\",\n \"returns\": \"TEXT\",\n \"max_batch_rows\": \"\",\n \"created_on\": \"\",\n \"signature\": \"\",\n \"language\": \"\",\n \"body\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"arguments\": [\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n },\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n }\n ],\n \"function_type\": \"service-function\",\n \"returns\": \"TEXT\",\n \"max_batch_rows\": \"\",\n \"created_on\": \"\",\n \"signature\": \"\",\n \"language\": \"\",\n \"body\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"arguments\": [\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n },\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n }\n ],\n \"function_type\": \"service-function\",\n \"returns\": \"TEXT\",\n \"max_batch_rows\": \"\",\n \"created_on\": \"\",\n \"signature\": \"\",\n \"language\": \"\",\n \"body\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"arguments\": [\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n },\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n }\n ],\n \"function_type\": \"service-function\",\n \"returns\": \"TEXT\",\n \"max_batch_rows\": \"\",\n \"created_on\": \"\",\n \"signature\": \"\",\n \"language\": \"\",\n \"body\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"arguments\": [\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n },\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n }\n ],\n \"function_type\": \"service-function\",\n \"returns\": \"TEXT\",\n \"max_batch_rows\": \"\",\n \"created_on\": \"\",\n \"signature\": \"\",\n \"language\": \"\",\n \"body\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"arguments\": [\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n },\n {\n \"name\": \"\",\n \"datatype\": \"TEXT\",\n \"value\": {\n \"description\": \"Argument's value\"\n }\n }\n ],\n \"function_type\": \"service-function\",\n \"returns\": \"TEXT\",\n \"max_batch_rows\": \"\",\n \"created_on\": \"\",\n \"signature\": \"\",\n \"language\": \"\",\n \"body\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/functions?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "functions" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + }, + { + "key": "name", + "value": "hpXyfrqcY" + } + ] +} \ No newline at end of file diff --git a/public-preview/8.30/collection/Snowflake Grant API.postman_collection.json b/public-preview/8.30/collection/Snowflake Grant API.postman_collection.json new file mode 100644 index 0000000..3fed1de --- /dev/null +++ b/public-preview/8.30/collection/Snowflake Grant API.postman_collection.json @@ -0,0 +1,7441 @@ +{ + "info": { + "_postman_id": "f341c874-4028-4e02-9f9e-668117ed9816", + "name": "Snowflake Grant API", + "description": "The Snowflake Grant API is a REST API that you can use to show or manage privileges that have been provided to users and roles 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": "28868798", + "_collection_link": "https://snowflake.postman.co/workspace/SnowApi-PuPr~785f3044-d2f3-4a33-8fea-8707898185ed/collection/28868798-f341c874-4028-4e02-9f9e-668117ed9816?action=share&source=collection_link&creator=28868798" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "grants", + "item": [ + { + "name": "{granteeType}", + "item": [ + { + "name": "{granteeName}", + "item": [ + { + "name": "{securableType}", + "item": [ + { + "name": "{securableName}", + "item": [ + { + "name": "privileges", + "item": [ + { + "name": "{privilege}", + "item": [ + { + "name": "grant-option", + "item": [ + { + "name": "Revoke the grant option for the specified privilege on the named securable from the named grantee.", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges/:privilege/grant-option?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges", + ":privilege", + "grant-option" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType", + "value": "role", + "description": "(Required) String that specifies the type of resource that is the privilege grantee." + }, + { + "key": "granteeName", + "value": "", + "description": "(Required) String that specifies the name of the privilege grantee." + }, + { + "key": "securableType", + "value": "", + "description": "(Required) String that specifies the type of resource that is being secured by a privilege." + }, + { + "key": "securableName", + "value": "", + "description": "(Required) String that specifies the name of resource that is being secured by a privilege." + }, + { + "key": "privilege", + "value": "", + "description": "(Required) String that specifies a privilege to be revoked" + } + ] + }, + "description": "Endpoint to indicate that the grant option for the privilege listed in the path should be revoked." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges/:privilege/grant-option?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges", + ":privilege", + "grant-option" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges/:privilege/grant-option?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges", + ":privilege", + "grant-option" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges/:privilege/grant-option?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges", + ":privilege", + "grant-option" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges/:privilege/grant-option?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges", + ":privilege", + "grant-option" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges/:privilege/grant-option?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges", + ":privilege", + "grant-option" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges/:privilege/grant-option?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges", + ":privilege", + "grant-option" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges/:privilege/grant-option?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges", + ":privilege", + "grant-option" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges/:privilege/grant-option?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges", + ":privilege", + "grant-option" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges/:privilege/grant-option?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges", + ":privilege", + "grant-option" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges/:privilege/grant-option?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges", + ":privilege", + "grant-option" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges/:privilege/grant-option?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges", + ":privilege", + "grant-option" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges/:privilege/grant-option?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges", + ":privilege", + "grant-option" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges/:privilege/grant-option?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges", + ":privilege", + "grant-option" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "Revoke the specified privilege on the named securable from the named grantee.", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges/:privilege?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges", + ":privilege" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType", + "value": "role", + "description": "(Required) String that specifies the type of resource that is the privilege grantee." + }, + { + "key": "granteeName", + "value": "", + "description": "(Required) String that specifies the name of the privilege grantee." + }, + { + "key": "securableType", + "value": "", + "description": "(Required) String that specifies the type of resource that is being secured by a privilege." + }, + { + "key": "securableName", + "value": "", + "description": "(Required) String that specifies the name of resource that is being secured by a privilege." + }, + { + "key": "privilege", + "value": "", + "description": "(Required) String that specifies a privilege to be revoked" + } + ] + }, + "description": "Endpoint to indicate that the privilege listed in the path should be revoked." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges/:privilege?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges", + ":privilege" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges/:privilege?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges", + ":privilege" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges/:privilege?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges", + ":privilege" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges/:privilege?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges", + ":privilege" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges/:privilege?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges", + ":privilege" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges/:privilege?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges", + ":privilege" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges/:privilege?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges", + ":privilege" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges/:privilege?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges", + ":privilege" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges/:privilege?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges", + ":privilege" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges/:privilege?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges", + ":privilege" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges/:privilege?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges", + ":privilege" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges/:privilege?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges", + ":privilege" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges/:privilege?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges", + ":privilege" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "Grant the specified privilege(s) on the named securable to the named grantee.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"grant_option\": \"\",\n \"created_on\": \"\",\n \"grantee_type\": \"\",\n \"grantee_name\": \"\",\n \"securable_type\": \"\",\n \"securable_name\": \"\",\n \"granted_by_role_type\": \"\",\n \"granted_by_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges" + ], + "variable": [ + { + "key": "granteeType", + "value": "role", + "description": "(Required) String that specifies the type of resource that is the privilege grantee." + }, + { + "key": "granteeName", + "value": "", + "description": "(Required) String that specifies the name of the privilege grantee." + }, + { + "key": "securableType", + "value": "", + "description": "(Required) String that specifies the type of resource that is being secured by a privilege." + }, + { + "key": "securableName", + "value": "", + "description": "(Required) String that specifies the name of resource that is being secured by a privilege." + } + ] + }, + "description": "Endpoint to indicate that the privileges listed in the request body should be granted." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"grant_option\": \"\",\n \"created_on\": \"\",\n \"grantee_type\": \"\",\n \"grantee_name\": \"\",\n \"securable_type\": \"\",\n \"securable_name\": \"\",\n \"granted_by_role_type\": \"\",\n \"granted_by_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"grant_option\": \"\",\n \"created_on\": \"\",\n \"grantee_type\": \"\",\n \"grantee_name\": \"\",\n \"securable_type\": \"\",\n \"securable_name\": \"\",\n \"granted_by_role_type\": \"\",\n \"granted_by_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"grant_option\": \"\",\n \"created_on\": \"\",\n \"grantee_type\": \"\",\n \"grantee_name\": \"\",\n \"securable_type\": \"\",\n \"securable_name\": \"\",\n \"granted_by_role_type\": \"\",\n \"granted_by_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"grant_option\": \"\",\n \"created_on\": \"\",\n \"grantee_type\": \"\",\n \"grantee_name\": \"\",\n \"securable_type\": \"\",\n \"securable_name\": \"\",\n \"granted_by_role_type\": \"\",\n \"granted_by_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"grant_option\": \"\",\n \"created_on\": \"\",\n \"grantee_type\": \"\",\n \"grantee_name\": \"\",\n \"securable_type\": \"\",\n \"securable_name\": \"\",\n \"granted_by_role_type\": \"\",\n \"granted_by_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"grant_option\": \"\",\n \"created_on\": \"\",\n \"grantee_type\": \"\",\n \"grantee_name\": \"\",\n \"securable_type\": \"\",\n \"securable_name\": \"\",\n \"granted_by_role_type\": \"\",\n \"granted_by_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"grant_option\": \"\",\n \"created_on\": \"\",\n \"grantee_type\": \"\",\n \"grantee_name\": \"\",\n \"securable_type\": \"\",\n \"securable_name\": \"\",\n \"granted_by_role_type\": \"\",\n \"granted_by_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"grant_option\": \"\",\n \"created_on\": \"\",\n \"grantee_type\": \"\",\n \"grantee_name\": \"\",\n \"securable_type\": \"\",\n \"securable_name\": \"\",\n \"granted_by_role_type\": \"\",\n \"granted_by_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"grant_option\": \"\",\n \"created_on\": \"\",\n \"grantee_type\": \"\",\n \"grantee_name\": \"\",\n \"securable_type\": \"\",\n \"securable_name\": \"\",\n \"granted_by_role_type\": \"\",\n \"granted_by_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"grant_option\": \"\",\n \"created_on\": \"\",\n \"grantee_type\": \"\",\n \"grantee_name\": \"\",\n \"securable_type\": \"\",\n \"securable_name\": \"\",\n \"granted_by_role_type\": \"\",\n \"granted_by_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"grant_option\": \"\",\n \"created_on\": \"\",\n \"grantee_type\": \"\",\n \"grantee_name\": \"\",\n \"securable_type\": \"\",\n \"securable_name\": \"\",\n \"granted_by_role_type\": \"\",\n \"granted_by_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"grant_option\": \"\",\n \"created_on\": \"\",\n \"grantee_type\": \"\",\n \"grantee_name\": \"\",\n \"securable_type\": \"\",\n \"securable_name\": \"\",\n \"granted_by_role_type\": \"\",\n \"granted_by_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"grant_option\": \"\",\n \"created_on\": \"\",\n \"grantee_type\": \"\",\n \"grantee_name\": \"\",\n \"securable_type\": \"\",\n \"securable_name\": \"\",\n \"granted_by_role_type\": \"\",\n \"granted_by_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:securableType/:securableName/privileges", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":securableType", + ":securableName", + "privileges" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "securableType" + }, + { + "key": "securableName" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + } + ] + } + ] + }, + { + "name": "{bulkGrantType}", + "item": [ + { + "name": "{securableTypePlural}", + "item": [ + { + "name": "{scopeType}", + "item": [ + { + "name": "{scopeName}", + "item": [ + { + "name": "privileges", + "item": [ + { + "name": "{privilege}", + "item": [ + { + "name": "grant-option", + "item": [ + { + "name": "Revoke the grant option for the specified privilege on the specified all/future securable in the given scope from the named grantee.", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges/:privilege/grant-option?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges", + ":privilege", + "grant-option" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType", + "value": "role", + "description": "(Required) String that specifies the type of resource that is the privilege grantee." + }, + { + "key": "granteeName", + "value": "", + "description": "(Required) String that specifies the name of the privilege grantee." + }, + { + "key": "bulkGrantType", + "value": "future", + "description": "(Required) String that species whether this group privilege should be on ALL or FUTURE resources of the specified plural type" + }, + { + "key": "securableTypePlural", + "value": "", + "description": "(Required) String that specifies the plural of the type of resource that is being secured by an ALL/FUTURE privilege. Must be either \"schemas\" or any plural object type that can nest under a schema such as \"tables\"" + }, + { + "key": "scopeType", + "value": "database", + "description": "(Required) String that specifies the type of resource that is the scope of an ALL/FUTURE privilege. Can only be DATABASE or SCHEMA" + }, + { + "key": "scopeName", + "value": "", + "description": "(Required) String that specifies the name of resource that is the scope of an ALL/FUTURE privilege" + }, + { + "key": "privilege", + "value": "", + "description": "(Required) String that specifies a privilege to be revoked" + } + ] + }, + "description": "Endpoint to indicate that the grant option for the privilege listed on the group securable in the given scope should be revoked." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges/:privilege/grant-option?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges", + ":privilege", + "grant-option" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges/:privilege/grant-option?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges", + ":privilege", + "grant-option" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges/:privilege/grant-option?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges", + ":privilege", + "grant-option" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges/:privilege/grant-option?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges", + ":privilege", + "grant-option" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges/:privilege/grant-option?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges", + ":privilege", + "grant-option" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges/:privilege/grant-option?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges", + ":privilege", + "grant-option" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges/:privilege/grant-option?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges", + ":privilege", + "grant-option" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges/:privilege/grant-option?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges", + ":privilege", + "grant-option" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges/:privilege/grant-option?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges", + ":privilege", + "grant-option" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges/:privilege/grant-option?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges", + ":privilege", + "grant-option" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges/:privilege/grant-option?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges", + ":privilege", + "grant-option" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges/:privilege/grant-option?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges", + ":privilege", + "grant-option" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges/:privilege/grant-option?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges", + ":privilege", + "grant-option" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "Revoke the specified privilege on the specified all/future securable in the given scope from the named grantee.", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges/:privilege?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges", + ":privilege" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType", + "value": "role", + "description": "(Required) String that specifies the type of resource that is the privilege grantee." + }, + { + "key": "granteeName", + "value": "", + "description": "(Required) String that specifies the name of the privilege grantee." + }, + { + "key": "bulkGrantType", + "value": "future", + "description": "(Required) String that species whether this group privilege should be on ALL or FUTURE resources of the specified plural type" + }, + { + "key": "securableTypePlural", + "value": "", + "description": "(Required) String that specifies the plural of the type of resource that is being secured by an ALL/FUTURE privilege. Must be either \"schemas\" or any plural object type that can nest under a schema such as \"tables\"" + }, + { + "key": "scopeType", + "value": "database", + "description": "(Required) String that specifies the type of resource that is the scope of an ALL/FUTURE privilege. Can only be DATABASE or SCHEMA" + }, + { + "key": "scopeName", + "value": "", + "description": "(Required) String that specifies the name of resource that is the scope of an ALL/FUTURE privilege" + }, + { + "key": "privilege", + "value": "", + "description": "(Required) String that specifies a privilege to be revoked" + } + ] + }, + "description": "Endpoint to indicate that the privilege listed on the group securable in the given scope should be revoked." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges/:privilege?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges", + ":privilege" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges/:privilege?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges", + ":privilege" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges/:privilege?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges", + ":privilege" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges/:privilege?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges", + ":privilege" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges/:privilege?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges", + ":privilege" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges/:privilege?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges", + ":privilege" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges/:privilege?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges", + ":privilege" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges/:privilege?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges", + ":privilege" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges/:privilege?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges", + ":privilege" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges/:privilege?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges", + ":privilege" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges/:privilege?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges", + ":privilege" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges/:privilege?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges", + ":privilege" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges/:privilege?deleteMode=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges", + ":privilege" + ], + "query": [ + { + "key": "deleteMode", + "value": "", + "description": "If \"cascade\", recursively revoke the grant from sub-grantees to which this privilege was re-granted. Acceptable values are \"restrict\" or \"cascade\"." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + }, + { + "key": "privilege" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "Grant the specified privilege(s) on all/future (as specified by bulkGrantType) securables of this type in a given scope to the named grantee.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"grant_option\": \"\",\n \"created_on\": \"\",\n \"grantee_type\": \"\",\n \"grantee_name\": \"\",\n \"securable_type\": \"\",\n \"securable_name\": \"\",\n \"granted_by_role_type\": \"\",\n \"granted_by_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges" + ], + "variable": [ + { + "key": "granteeType", + "value": "role", + "description": "(Required) String that specifies the type of resource that is the privilege grantee." + }, + { + "key": "granteeName", + "value": "", + "description": "(Required) String that specifies the name of the privilege grantee." + }, + { + "key": "bulkGrantType", + "value": "future", + "description": "(Required) String that species whether this group privilege should be on ALL or FUTURE resources of the specified plural type" + }, + { + "key": "securableTypePlural", + "value": "", + "description": "(Required) String that specifies the plural of the type of resource that is being secured by an ALL/FUTURE privilege. Must be either \"schemas\" or any plural object type that can nest under a schema such as \"tables\"" + }, + { + "key": "scopeType", + "value": "database", + "description": "(Required) String that specifies the type of resource that is the scope of an ALL/FUTURE privilege. Can only be DATABASE or SCHEMA" + }, + { + "key": "scopeName", + "value": "", + "description": "(Required) String that specifies the name of resource that is the scope of an ALL/FUTURE privilege" + } + ] + }, + "description": "Endpoint to indicate that the privileges listed in the request body should be granted to all securables of this type in the given scope." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"grant_option\": \"\",\n \"created_on\": \"\",\n \"grantee_type\": \"\",\n \"grantee_name\": \"\",\n \"securable_type\": \"\",\n \"securable_name\": \"\",\n \"granted_by_role_type\": \"\",\n \"granted_by_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"grant_option\": \"\",\n \"created_on\": \"\",\n \"grantee_type\": \"\",\n \"grantee_name\": \"\",\n \"securable_type\": \"\",\n \"securable_name\": \"\",\n \"granted_by_role_type\": \"\",\n \"granted_by_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"grant_option\": \"\",\n \"created_on\": \"\",\n \"grantee_type\": \"\",\n \"grantee_name\": \"\",\n \"securable_type\": \"\",\n \"securable_name\": \"\",\n \"granted_by_role_type\": \"\",\n \"granted_by_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"grant_option\": \"\",\n \"created_on\": \"\",\n \"grantee_type\": \"\",\n \"grantee_name\": \"\",\n \"securable_type\": \"\",\n \"securable_name\": \"\",\n \"granted_by_role_type\": \"\",\n \"granted_by_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"grant_option\": \"\",\n \"created_on\": \"\",\n \"grantee_type\": \"\",\n \"grantee_name\": \"\",\n \"securable_type\": \"\",\n \"securable_name\": \"\",\n \"granted_by_role_type\": \"\",\n \"granted_by_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"grant_option\": \"\",\n \"created_on\": \"\",\n \"grantee_type\": \"\",\n \"grantee_name\": \"\",\n \"securable_type\": \"\",\n \"securable_name\": \"\",\n \"granted_by_role_type\": \"\",\n \"granted_by_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"grant_option\": \"\",\n \"created_on\": \"\",\n \"grantee_type\": \"\",\n \"grantee_name\": \"\",\n \"securable_type\": \"\",\n \"securable_name\": \"\",\n \"granted_by_role_type\": \"\",\n \"granted_by_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"grant_option\": \"\",\n \"created_on\": \"\",\n \"grantee_type\": \"\",\n \"grantee_name\": \"\",\n \"securable_type\": \"\",\n \"securable_name\": \"\",\n \"granted_by_role_type\": \"\",\n \"granted_by_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"grant_option\": \"\",\n \"created_on\": \"\",\n \"grantee_type\": \"\",\n \"grantee_name\": \"\",\n \"securable_type\": \"\",\n \"securable_name\": \"\",\n \"granted_by_role_type\": \"\",\n \"granted_by_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"grant_option\": \"\",\n \"created_on\": \"\",\n \"grantee_type\": \"\",\n \"grantee_name\": \"\",\n \"securable_type\": \"\",\n \"securable_name\": \"\",\n \"granted_by_role_type\": \"\",\n \"granted_by_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"grant_option\": \"\",\n \"created_on\": \"\",\n \"grantee_type\": \"\",\n \"grantee_name\": \"\",\n \"securable_type\": \"\",\n \"securable_name\": \"\",\n \"granted_by_role_type\": \"\",\n \"granted_by_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"grant_option\": \"\",\n \"created_on\": \"\",\n \"grantee_type\": \"\",\n \"grantee_name\": \"\",\n \"securable_type\": \"\",\n \"securable_name\": \"\",\n \"granted_by_role_type\": \"\",\n \"granted_by_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"grant_option\": \"\",\n \"created_on\": \"\",\n \"grantee_type\": \"\",\n \"grantee_name\": \"\",\n \"securable_type\": \"\",\n \"securable_name\": \"\",\n \"granted_by_role_type\": \"\",\n \"granted_by_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName/:bulkGrantType/:securableTypePlural/:scopeType/:scopeName/privileges", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName", + ":bulkGrantType", + ":securableTypePlural", + ":scopeType", + ":scopeName", + "privileges" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + }, + { + "key": "bulkGrantType" + }, + { + "key": "securableTypePlural" + }, + { + "key": "scopeType" + }, + { + "key": "scopeName" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + }, + { + "name": "List of privileges associated with this grantee type and name", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "variable": [ + { + "key": "granteeType", + "value": "role", + "description": "(Required) String that specifies the type of resource that is the privilege grantee." + }, + { + "key": "granteeName", + "value": "", + "description": "(Required) String that specifies the name of the privilege grantee." + } + ] + }, + "description": "List the roles and privileges granted to the specified grantee using the output of SHOW GRANTS TO" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"grant_option\": \"\",\n \"created_on\": \"\",\n \"grantee_type\": \"\",\n \"grantee_name\": \"\",\n \"securable_type\": \"\",\n \"securable_name\": \"\",\n \"granted_by_role_type\": \"\",\n \"granted_by_name\": \"\"\n },\n {\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"grant_option\": \"\",\n \"created_on\": \"\",\n \"grantee_type\": \"\",\n \"grantee_name\": \"\",\n \"securable_type\": \"\",\n \"securable_name\": \"\",\n \"granted_by_role_type\": \"\",\n \"granted_by_name\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + } + ] +} \ No newline at end of file diff --git a/public-preview/8.30/collection/Snowflake Image Repository API.postman_collection.json b/public-preview/8.30/collection/Snowflake Image Repository API.postman_collection.json new file mode 100644 index 0000000..6051a01 --- /dev/null +++ b/public-preview/8.30/collection/Snowflake Image Repository API.postman_collection.json @@ -0,0 +1,4001 @@ +{ + "info": { + "_postman_id": "dc5a9715-41c5-4bc2-8144-9b9141fc58f5", + "name": "Snowflake Image Repository API", + "description": "The Snowflake Image Repository API is a REST API that you can use to access, update, and perform common actions on Image Repository resource in Snowflake.\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": "28868798", + "_collection_link": "https://snowflake.postman.co/workspace/SnowApi-PuPr~785f3044-d2f3-4a33-8fea-8707898185ed/collection/28868798-dc5a9715-41c5-4bc2-8144-9b9141fc58f5?action=share&source=collection_link&creator=28868798" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "databases", + "item": [ + { + "name": "{database}", + "item": [ + { + "name": "schemas", + "item": [ + { + "name": "{schema}", + "item": [ + { + "name": "image-repositories", + "item": [ + { + "name": "{name}", + "item": [ + { + "name": "images", + "item": [ + { + "name": "List images in the image repository.", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name/images", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name", + "images" + ], + "variable": [ + { + "key": "database", + "value": "XbRtuy5O", + "description": "(Required) 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": "XbRtuy5O", + "description": "(Required) 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": "XbRtuy5O", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "List images in the given image repository." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name/images", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name", + "images" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"images\": [\n \"\",\n \"\"\n ]\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name/images", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name", + "images" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name/images", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name", + "images" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name/images", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name", + "images" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name/images", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name", + "images" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name/images", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name", + "images" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name/images", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name", + "images" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name/images", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name", + "images" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name/images", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name", + "images" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name/images", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name", + "images" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name/images", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name", + "images" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "Fetches an image repository.", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "variable": [ + { + "key": "database", + "value": "XbRtuy5O", + "description": "(Required) 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": "XbRtuy5O", + "description": "(Required) 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": "XbRtuy5O", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Fetches a named image repository in a specified database and schema." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"I\\\"\\\"?\\\"\\\"\\\"\\\"ky\\\"\\\"J\\\"\",\n \"database_name\": \"GoZ\",\n \"schema_name\": \"Vaoz\",\n \"created_on\": \"\",\n \"repository_url\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "Deletes an image repository.", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database", + "value": "XbRtuy5O", + "description": "(Required) 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": "XbRtuy5O", + "description": "(Required) 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": "XbRtuy5O", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Deletes an image repository with the given name. If you enable the `ifExists` query parameter, the operation succeeds even if the object does not exist. Otherwise, a 404 failure is returned if the object does not exist." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "Lists image repositories.", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database", + "value": "XbRtuy5O", + "description": "(Required) 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": "XbRtuy5O", + "description": "(Required) 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 image repositories under a specified database and schema." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"\\\"\\\"\\\"|?9\\\"\\\"j\\\"\\\"M\\\"\",\n \"database_name\": \"\\\"\\\"\\\"\\\"\\\"w\\\"\\\"\\\"\",\n \"schema_name\": \"MIDBw0O7gS\",\n \"created_on\": \"\",\n \"repository_url\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\"\n },\n {\n \"name\": \"QsPLnZl\",\n \"database_name\": \"\\\"\\\\\\\"\\\"U s\\\"\",\n \"schema_name\": \"\\\"J\\\"\\\"c\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"R\\\"\",\n \"created_on\": \"\",\n \"repository_url\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "Creates an image repository in the specified database and schema.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"I\\\"\\\"?\\\"\\\"\\\"\\\"ky\\\"\\\"J\\\"\",\n \"database_name\": \"GoZ\",\n \"schema_name\": \"Vaoz\",\n \"created_on\": \"\",\n \"repository_url\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database", + "value": "XbRtuy5O", + "description": "(Required) 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": "XbRtuy5O", + "description": "(Required) 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": "Creates an image repository in the specified database, schema, and create mode. The `createMode` query parameter specifies what action to take based on whether the repository already exists. See the ImageRepository 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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"I\\\"\\\"?\\\"\\\"\\\"\\\"ky\\\"\\\"J\\\"\",\n \"database_name\": \"GoZ\",\n \"schema_name\": \"Vaoz\",\n \"created_on\": \"\",\n \"repository_url\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"I\\\"\\\"?\\\"\\\"\\\"\\\"ky\\\"\\\"J\\\"\",\n \"database_name\": \"GoZ\",\n \"schema_name\": \"Vaoz\",\n \"created_on\": \"\",\n \"repository_url\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"I\\\"\\\"?\\\"\\\"\\\"\\\"ky\\\"\\\"J\\\"\",\n \"database_name\": \"GoZ\",\n \"schema_name\": \"Vaoz\",\n \"created_on\": \"\",\n \"repository_url\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"I\\\"\\\"?\\\"\\\"\\\"\\\"ky\\\"\\\"J\\\"\",\n \"database_name\": \"GoZ\",\n \"schema_name\": \"Vaoz\",\n \"created_on\": \"\",\n \"repository_url\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"I\\\"\\\"?\\\"\\\"\\\"\\\"ky\\\"\\\"J\\\"\",\n \"database_name\": \"GoZ\",\n \"schema_name\": \"Vaoz\",\n \"created_on\": \"\",\n \"repository_url\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"I\\\"\\\"?\\\"\\\"\\\"\\\"ky\\\"\\\"J\\\"\",\n \"database_name\": \"GoZ\",\n \"schema_name\": \"Vaoz\",\n \"created_on\": \"\",\n \"repository_url\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"I\\\"\\\"?\\\"\\\"\\\"\\\"ky\\\"\\\"J\\\"\",\n \"database_name\": \"GoZ\",\n \"schema_name\": \"Vaoz\",\n \"created_on\": \"\",\n \"repository_url\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"I\\\"\\\"?\\\"\\\"\\\"\\\"ky\\\"\\\"J\\\"\",\n \"database_name\": \"GoZ\",\n \"schema_name\": \"Vaoz\",\n \"created_on\": \"\",\n \"repository_url\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"I\\\"\\\"?\\\"\\\"\\\"\\\"ky\\\"\\\"J\\\"\",\n \"database_name\": \"GoZ\",\n \"schema_name\": \"Vaoz\",\n \"created_on\": \"\",\n \"repository_url\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"I\\\"\\\"?\\\"\\\"\\\"\\\"ky\\\"\\\"J\\\"\",\n \"database_name\": \"GoZ\",\n \"schema_name\": \"Vaoz\",\n \"created_on\": \"\",\n \"repository_url\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"I\\\"\\\"?\\\"\\\"\\\"\\\"ky\\\"\\\"J\\\"\",\n \"database_name\": \"GoZ\",\n \"schema_name\": \"Vaoz\",\n \"created_on\": \"\",\n \"repository_url\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"I\\\"\\\"?\\\"\\\"\\\"\\\"ky\\\"\\\"J\\\"\",\n \"database_name\": \"GoZ\",\n \"schema_name\": \"Vaoz\",\n \"created_on\": \"\",\n \"repository_url\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + } + ] +} \ No newline at end of file diff --git a/public-preview/8.30/collection/Snowflake Result API.postman_collection.json b/public-preview/8.30/collection/Snowflake Result API.postman_collection.json new file mode 100644 index 0000000..08b7b9c --- /dev/null +++ b/public-preview/8.30/collection/Snowflake Result API.postman_collection.json @@ -0,0 +1,692 @@ +{ + "info": { + "_postman_id": "b38b6900-7154-4fa6-9528-2adaa19380d7", + "name": "Snowflake Result API", + "description": "The Snowflake Result API is a REST API that you can use to check request status and fetch request response.\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": "28868798", + "_collection_link": "https://snowflake.postman.co/workspace/SnowApi-PuPr~785f3044-d2f3-4a33-8fea-8707898185ed/collection/28868798-b38b6900-7154-4fa6-9528-2adaa19380d7?action=share&source=collection_link&creator=28868798" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "results", + "item": [ + { + "name": "{result_handler}", + "item": [ + { + "name": "Check result status or fetch request", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/results/:result_handler?page=0", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "results", + ":result_handler" + ], + "query": [ + { + "key": "page", + "value": "0", + "description": "Number of the page of results to return. The number can range from 0 to the total number of pages minus 1." + } + ], + "variable": [ + { + "key": "result_handler", + "value": "", + "description": "(Required) The opaque result id." + } + ] + }, + "description": "Get result status or the result when it is ready." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/results/:result_handler?page=0", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "results", + ":result_handler" + ], + "query": [ + { + "key": "page", + "value": "0", + "description": "Number of the page of results to return. The number can range from 0 to the total number of pages minus 1." + } + ], + "variable": [ + { + "key": "result_handler" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/results/:result_handler?page=0", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "results", + ":result_handler" + ], + "query": [ + { + "key": "page", + "value": "0", + "description": "Number of the page of results to return. The number can range from 0 to the total number of pages minus 1." + } + ], + "variable": [ + { + "key": "result_handler" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/results/:result_handler?page=0", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "results", + ":result_handler" + ], + "query": [ + { + "key": "page", + "value": "0", + "description": "Number of the page of results to return. The number can range from 0 to the total number of pages minus 1." + } + ], + "variable": [ + { + "key": "result_handler" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/results/:result_handler?page=0", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "results", + ":result_handler" + ], + "query": [ + { + "key": "page", + "value": "0", + "description": "Number of the page of results to return. The number can range from 0 to the total number of pages minus 1." + } + ], + "variable": [ + { + "key": "result_handler" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/results/:result_handler?page=0", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "results", + ":result_handler" + ], + "query": [ + { + "key": "page", + "value": "0", + "description": "Number of the page of results to return. The number can range from 0 to the total number of pages minus 1." + } + ], + "variable": [ + { + "key": "result_handler" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/results/:result_handler?page=0", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "results", + ":result_handler" + ], + "query": [ + { + "key": "page", + "value": "0", + "description": "Number of the page of results to return. The number can range from 0 to the total number of pages minus 1." + } + ], + "variable": [ + { + "key": "result_handler" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/results/:result_handler?page=0", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "results", + ":result_handler" + ], + "query": [ + { + "key": "page", + "value": "0", + "description": "Number of the page of results to return. The number can range from 0 to the total number of pages minus 1." + } + ], + "variable": [ + { + "key": "result_handler" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/results/:result_handler?page=0", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "results", + ":result_handler" + ], + "query": [ + { + "key": "page", + "value": "0", + "description": "Number of the page of results to return. The number can range from 0 to the total number of pages minus 1." + } + ], + "variable": [ + { + "key": "result_handler" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/results/:result_handler?page=0", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "results", + ":result_handler" + ], + "query": [ + { + "key": "page", + "value": "0", + "description": "Number of the page of results to return. The number can range from 0 to the total number of pages minus 1." + } + ], + "variable": [ + { + "key": "result_handler" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/results/:result_handler?page=0", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "results", + ":result_handler" + ], + "query": [ + { + "key": "page", + "value": "0", + "description": "Number of the page of results to return. The number can range from 0 to the total number of pages minus 1." + } + ], + "variable": [ + { + "key": "result_handler" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/results/:result_handler?page=0", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "results", + ":result_handler" + ], + "query": [ + { + "key": "page", + "value": "0", + "description": "Number of the page of results to return. The number can range from 0 to the total number of pages minus 1." + } + ], + "variable": [ + { + "key": "result_handler" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + } + ] +} \ No newline at end of file diff --git a/public-preview/8.30/collection/Snowflake Role API.postman_collection.json b/public-preview/8.30/collection/Snowflake Role API.postman_collection.json new file mode 100644 index 0000000..65f94cd --- /dev/null +++ b/public-preview/8.30/collection/Snowflake Role API.postman_collection.json @@ -0,0 +1,2564 @@ +{ + "info": { + "_postman_id": "29cec5b5-fa8b-4893-ac19-2aa8ada3ed19", + "name": "Snowflake Role API", + "description": "The Snowflake Role API is a REST API that you can use to access, update, and perform certain action on Roles 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": "28868798", + "_collection_link": "https://snowflake.postman.co/workspace/SnowApi-PuPr~785f3044-d2f3-4a33-8fea-8707898185ed/collection/28868798-29cec5b5-fa8b-4893-ac19-2aa8ada3ed19?action=share&source=collection_link&creator=28868798" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "roles", + "item": [ + { + "name": "{name}", + "item": [ + { + "name": "Delete a role", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name", + "value": "HXPLE", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Delete a role with the given name." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "Create a role", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"is_inherited\": \"\",\n \"assigned_to_users\": \"\",\n \"granted_to_roles\": \"\",\n \"granted_roles\": \"\",\n \"owner\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + }, + "description": "Create a role according to the parameters given" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"is_inherited\": \"\",\n \"assigned_to_users\": \"\",\n \"granted_to_roles\": \"\",\n \"granted_roles\": \"\",\n \"owner\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"is_inherited\": \"\",\n \"assigned_to_users\": \"\",\n \"granted_to_roles\": \"\",\n \"granted_roles\": \"\",\n \"owner\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"is_inherited\": \"\",\n \"assigned_to_users\": \"\",\n \"granted_to_roles\": \"\",\n \"granted_roles\": \"\",\n \"owner\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"is_inherited\": \"\",\n \"assigned_to_users\": \"\",\n \"granted_to_roles\": \"\",\n \"granted_roles\": \"\",\n \"owner\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"is_inherited\": \"\",\n \"assigned_to_users\": \"\",\n \"granted_to_roles\": \"\",\n \"granted_roles\": \"\",\n \"owner\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"is_inherited\": \"\",\n \"assigned_to_users\": \"\",\n \"granted_to_roles\": \"\",\n \"granted_roles\": \"\",\n \"owner\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"is_inherited\": \"\",\n \"assigned_to_users\": \"\",\n \"granted_to_roles\": \"\",\n \"granted_roles\": \"\",\n \"owner\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"is_inherited\": \"\",\n \"assigned_to_users\": \"\",\n \"granted_to_roles\": \"\",\n \"granted_roles\": \"\",\n \"owner\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"is_inherited\": \"\",\n \"assigned_to_users\": \"\",\n \"granted_to_roles\": \"\",\n \"granted_roles\": \"\",\n \"owner\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"is_inherited\": \"\",\n \"assigned_to_users\": \"\",\n \"granted_to_roles\": \"\",\n \"granted_roles\": \"\",\n \"owner\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"is_inherited\": \"\",\n \"assigned_to_users\": \"\",\n \"granted_to_roles\": \"\",\n \"granted_roles\": \"\",\n \"owner\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"is_inherited\": \"\",\n \"assigned_to_users\": \"\",\n \"granted_to_roles\": \"\",\n \"granted_roles\": \"\",\n \"owner\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"is_inherited\": \"\",\n \"assigned_to_users\": \"\",\n \"granted_to_roles\": \"\",\n \"granted_roles\": \"\",\n \"owner\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "List roles available to account", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ] + }, + "description": "Lists the roles available to the user's account" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"is_inherited\": \"\",\n \"assigned_to_users\": \"\",\n \"granted_to_roles\": \"\",\n \"granted_roles\": \"\",\n \"owner\": \"\"\n },\n {\n \"name\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"is_inherited\": \"\",\n \"assigned_to_users\": \"\",\n \"granted_to_roles\": \"\",\n \"granted_roles\": \"\",\n \"owner\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + } + ] + } + ] + } + ], + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + } + ] +} \ No newline at end of file diff --git a/public-preview/8.30/collection/Snowflake Schema API.postman_collection.json b/public-preview/8.30/collection/Snowflake Schema API.postman_collection.json new file mode 100644 index 0000000..b54fbd7 --- /dev/null +++ b/public-preview/8.30/collection/Snowflake Schema API.postman_collection.json @@ -0,0 +1,6666 @@ +{ + "info": { + "_postman_id": "0708a153-085a-409e-a48c-7242c6884468", + "name": "Snowflake Schema API", + "description": "The Snowflake Schema API is a REST API that you can use to access, update, and perform certain actions on a Snowflake schema.\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": "28868798", + "_collection_link": "https://snowflake.postman.co/workspace/SnowApi-PuPr~785f3044-d2f3-4a33-8fea-8707898185ed/collection/28868798-0708a153-085a-409e-a48c-7242c6884468?action=share&source=collection_link&creator=28868798" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "databases", + "item": [ + { + "name": "{database}", + "item": [ + { + "name": "schemas", + "item": [ + { + "name": "{name}:clone", + "item": [ + { + "name": "Clones a schema.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"v#\\\"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"e\",\n \"reference\": \"nisi dolor\"\n },\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/{{name}}:clone?createMode=errorIfExists&kind=&targetDatabase=F7o", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of schema to clone. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + }, + { + "key": "targetDatabase", + "value": "F7o", + "description": "Database of the newly created schema. Defaults to the source schema's database." + } + ], + "variable": [ + { + "key": "database", + "value": "F7o", + "description": "(Required) 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." + } + ] + }, + "description": "Clones an existing schema, with modifiers as query parameters. You must provide the full schema definition when cloning an existing schema." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"v#\\\"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"e\",\n \"reference\": \"nisi dolor\"\n },\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/{{name}}:clone?createMode=errorIfExists&kind=&targetDatabase=F7o", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of schema to clone. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + }, + { + "key": "targetDatabase", + "value": "F7o", + "description": "Database of the newly created schema. Defaults to the source schema's database." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"v#\\\"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"e\",\n \"reference\": \"nisi dolor\"\n },\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/{{name}}:clone?createMode=errorIfExists&kind=&targetDatabase=F7o", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of schema to clone. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + }, + { + "key": "targetDatabase", + "value": "F7o", + "description": "Database of the newly created schema. Defaults to the source schema's database." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"v#\\\"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"e\",\n \"reference\": \"nisi dolor\"\n },\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/{{name}}:clone?createMode=errorIfExists&kind=&targetDatabase=F7o", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of schema to clone. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + }, + { + "key": "targetDatabase", + "value": "F7o", + "description": "Database of the newly created schema. Defaults to the source schema's database." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"v#\\\"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"e\",\n \"reference\": \"nisi dolor\"\n },\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/{{name}}:clone?createMode=errorIfExists&kind=&targetDatabase=F7o", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of schema to clone. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + }, + { + "key": "targetDatabase", + "value": "F7o", + "description": "Database of the newly created schema. Defaults to the source schema's database." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"v#\\\"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"e\",\n \"reference\": \"nisi dolor\"\n },\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/{{name}}:clone?createMode=errorIfExists&kind=&targetDatabase=F7o", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of schema to clone. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + }, + { + "key": "targetDatabase", + "value": "F7o", + "description": "Database of the newly created schema. Defaults to the source schema's database." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"v#\\\"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"e\",\n \"reference\": \"nisi dolor\"\n },\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/{{name}}:clone?createMode=errorIfExists&kind=&targetDatabase=F7o", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of schema to clone. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + }, + { + "key": "targetDatabase", + "value": "F7o", + "description": "Database of the newly created schema. Defaults to the source schema's database." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"v#\\\"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"e\",\n \"reference\": \"nisi dolor\"\n },\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/{{name}}:clone?createMode=errorIfExists&kind=&targetDatabase=F7o", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of schema to clone. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + }, + { + "key": "targetDatabase", + "value": "F7o", + "description": "Database of the newly created schema. Defaults to the source schema's database." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"v#\\\"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"e\",\n \"reference\": \"nisi dolor\"\n },\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/{{name}}:clone?createMode=errorIfExists&kind=&targetDatabase=F7o", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of schema to clone. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + }, + { + "key": "targetDatabase", + "value": "F7o", + "description": "Database of the newly created schema. Defaults to the source schema's database." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"v#\\\"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"e\",\n \"reference\": \"nisi dolor\"\n },\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/{{name}}:clone?createMode=errorIfExists&kind=&targetDatabase=F7o", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of schema to clone. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + }, + { + "key": "targetDatabase", + "value": "F7o", + "description": "Database of the newly created schema. Defaults to the source schema's database." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"v#\\\"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"e\",\n \"reference\": \"nisi dolor\"\n },\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/{{name}}:clone?createMode=errorIfExists&kind=&targetDatabase=F7o", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of schema to clone. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + }, + { + "key": "targetDatabase", + "value": "F7o", + "description": "Database of the newly created schema. Defaults to the source schema's database." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"v#\\\"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"e\",\n \"reference\": \"nisi dolor\"\n },\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/{{name}}:clone?createMode=errorIfExists&kind=&targetDatabase=F7o", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of schema to clone. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + }, + { + "key": "targetDatabase", + "value": "F7o", + "description": "Database of the newly created schema. Defaults to the source schema's database." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"v#\\\"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"e\",\n \"reference\": \"nisi dolor\"\n },\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/{{name}}:clone?createMode=errorIfExists&kind=&targetDatabase=F7o", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of schema to clone. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + }, + { + "key": "targetDatabase", + "value": "F7o", + "description": "Database of the newly created schema. Defaults to the source schema's database." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"v#\\\"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"e\",\n \"reference\": \"nisi dolor\"\n },\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/{{name}}:clone?createMode=errorIfExists&kind=&targetDatabase=F7o", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of schema to clone. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + }, + { + "key": "targetDatabase", + "value": "F7o", + "description": "Database of the newly created schema. Defaults to the source schema's database." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:undrop", + "item": [ + { + "name": "Undrop a schema.", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database", + "value": "F7o", + "description": "(Required) 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." + } + ] + }, + "description": "Undrops schema." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}", + "item": [ + { + "name": "fetch Schema", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "variable": [ + { + "key": "database", + "value": "F7o", + "description": "(Required) 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": "name", + "value": "F7o", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Fetches a schema." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"name\": \"VKw97w4S60y\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "Creates a new, or alters an existing, schema.", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"VKw97w4S60y\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name?kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "query": [ + { + "key": "kind", + "value": "", + "description": "Type of schema to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ], + "variable": [ + { + "key": "database", + "value": "F7o", + "description": "(Required) 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": "name", + "value": "F7o", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Creates a new, or alters an existing, schema. You must provide the full schema definition even when altering an existing schema." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"VKw97w4S60y\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name?kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "query": [ + { + "key": "kind", + "value": "", + "description": "Type of schema to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"VKw97w4S60y\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name?kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "query": [ + { + "key": "kind", + "value": "", + "description": "Type of schema to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"VKw97w4S60y\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name?kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "query": [ + { + "key": "kind", + "value": "", + "description": "Type of schema to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"VKw97w4S60y\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name?kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "query": [ + { + "key": "kind", + "value": "", + "description": "Type of schema to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"VKw97w4S60y\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name?kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "query": [ + { + "key": "kind", + "value": "", + "description": "Type of schema to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"VKw97w4S60y\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name?kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "query": [ + { + "key": "kind", + "value": "", + "description": "Type of schema to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"VKw97w4S60y\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name?kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "query": [ + { + "key": "kind", + "value": "", + "description": "Type of schema to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"VKw97w4S60y\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name?kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "query": [ + { + "key": "kind", + "value": "", + "description": "Type of schema to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"VKw97w4S60y\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name?kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "query": [ + { + "key": "kind", + "value": "", + "description": "Type of schema to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"VKw97w4S60y\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name?kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "query": [ + { + "key": "kind", + "value": "", + "description": "Type of schema to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"VKw97w4S60y\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name?kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "query": [ + { + "key": "kind", + "value": "", + "description": "Type of schema to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"VKw97w4S60y\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name?kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "query": [ + { + "key": "kind", + "value": "", + "description": "Type of schema to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"VKw97w4S60y\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name?kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "query": [ + { + "key": "kind", + "value": "", + "description": "Type of schema to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "Deletes a schema.", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name?ifExists=false&restrict=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "restrict", + "value": "false", + "description": "Whether to drop the schema if foreign keys exist that reference any tables in the schema.\n- `true`: Return a warning about existing foreign key references and don't drop the schema.\n- `false`: Drop the schema and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables.\nDefault: `false`." + } + ], + "variable": [ + { + "key": "database", + "value": "F7o", + "description": "(Required) 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": "name", + "value": "F7o", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Deletes the specified schema. If you enable the `ifExists` parameter, the operation succeeds even if the schema does not exist. Otherwise, a 404 failure is returned if the schema does not exist. if the drop is unsuccessful." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name?ifExists=false&restrict=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "restrict", + "value": "false", + "description": "Whether to drop the schema if foreign keys exist that reference any tables in the schema.\n- `true`: Return a warning about existing foreign key references and don't drop the schema.\n- `false`: Drop the schema and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables.\nDefault: `false`." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name?ifExists=false&restrict=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "restrict", + "value": "false", + "description": "Whether to drop the schema if foreign keys exist that reference any tables in the schema.\n- `true`: Return a warning about existing foreign key references and don't drop the schema.\n- `false`: Drop the schema and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables.\nDefault: `false`." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name?ifExists=false&restrict=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "restrict", + "value": "false", + "description": "Whether to drop the schema if foreign keys exist that reference any tables in the schema.\n- `true`: Return a warning about existing foreign key references and don't drop the schema.\n- `false`: Drop the schema and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables.\nDefault: `false`." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name?ifExists=false&restrict=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "restrict", + "value": "false", + "description": "Whether to drop the schema if foreign keys exist that reference any tables in the schema.\n- `true`: Return a warning about existing foreign key references and don't drop the schema.\n- `false`: Drop the schema and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables.\nDefault: `false`." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name?ifExists=false&restrict=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "restrict", + "value": "false", + "description": "Whether to drop the schema if foreign keys exist that reference any tables in the schema.\n- `true`: Return a warning about existing foreign key references and don't drop the schema.\n- `false`: Drop the schema and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables.\nDefault: `false`." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name?ifExists=false&restrict=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "restrict", + "value": "false", + "description": "Whether to drop the schema if foreign keys exist that reference any tables in the schema.\n- `true`: Return a warning about existing foreign key references and don't drop the schema.\n- `false`: Drop the schema and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables.\nDefault: `false`." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name?ifExists=false&restrict=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "restrict", + "value": "false", + "description": "Whether to drop the schema if foreign keys exist that reference any tables in the schema.\n- `true`: Return a warning about existing foreign key references and don't drop the schema.\n- `false`: Drop the schema and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables.\nDefault: `false`." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name?ifExists=false&restrict=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "restrict", + "value": "false", + "description": "Whether to drop the schema if foreign keys exist that reference any tables in the schema.\n- `true`: Return a warning about existing foreign key references and don't drop the schema.\n- `false`: Drop the schema and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables.\nDefault: `false`." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name?ifExists=false&restrict=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "restrict", + "value": "false", + "description": "Whether to drop the schema if foreign keys exist that reference any tables in the schema.\n- `true`: Return a warning about existing foreign key references and don't drop the schema.\n- `false`: Drop the schema and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables.\nDefault: `false`." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name?ifExists=false&restrict=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "restrict", + "value": "false", + "description": "Whether to drop the schema if foreign keys exist that reference any tables in the schema.\n- `true`: Return a warning about existing foreign key references and don't drop the schema.\n- `false`: Drop the schema and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables.\nDefault: `false`." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name?ifExists=false&restrict=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "restrict", + "value": "false", + "description": "Whether to drop the schema if foreign keys exist that reference any tables in the schema.\n- `true`: Return a warning about existing foreign key references and don't drop the schema.\n- `false`: Drop the schema and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables.\nDefault: `false`." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name?ifExists=false&restrict=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "restrict", + "value": "false", + "description": "Whether to drop the schema if foreign keys exist that reference any tables in the schema.\n- `true`: Return a warning about existing foreign key references and don't drop the schema.\n- `false`: Drop the schema and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables.\nDefault: `false`." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name?ifExists=false&restrict=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "restrict", + "value": "false", + "description": "Whether to drop the schema if foreign keys exist that reference any tables in the schema.\n- `true`: Return a warning about existing foreign key references and don't drop the schema.\n- `false`: Drop the schema and all objects in the database, including tables with primary or unique keys that are referenced by foreign keys in other tables.\nDefault: `false`." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "Lists schemas.", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas?like=&startsWith=&showLimit=&fromName=&history=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "false", + "description": "Whether to include dropped schemas that have not yet been purged. Default: `false`." + } + ], + "variable": [ + { + "key": "database", + "value": "F7o", + "description": "(Required) 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." + } + ] + }, + "description": "Lists the accessible schemas." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas?like=&startsWith=&showLimit=&fromName=&history=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "false", + "description": "Whether to include dropped schemas that have not yet been purged. Default: `false`." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"P\\\"\\\"\\\"\\\"f\\\"\\\"o\\\"\\\"\\\"\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n },\n {\n \"name\": \"nMKTzaftdJ\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas?like=&startsWith=&showLimit=&fromName=&history=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "false", + "description": "Whether to include dropped schemas that have not yet been purged. Default: `false`." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas?like=&startsWith=&showLimit=&fromName=&history=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "false", + "description": "Whether to include dropped schemas that have not yet been purged. Default: `false`." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas?like=&startsWith=&showLimit=&fromName=&history=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "false", + "description": "Whether to include dropped schemas that have not yet been purged. Default: `false`." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas?like=&startsWith=&showLimit=&fromName=&history=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "false", + "description": "Whether to include dropped schemas that have not yet been purged. Default: `false`." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas?like=&startsWith=&showLimit=&fromName=&history=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "false", + "description": "Whether to include dropped schemas that have not yet been purged. Default: `false`." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas?like=&startsWith=&showLimit=&fromName=&history=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "false", + "description": "Whether to include dropped schemas that have not yet been purged. Default: `false`." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas?like=&startsWith=&showLimit=&fromName=&history=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "false", + "description": "Whether to include dropped schemas that have not yet been purged. Default: `false`." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas?like=&startsWith=&showLimit=&fromName=&history=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "false", + "description": "Whether to include dropped schemas that have not yet been purged. Default: `false`." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas?like=&startsWith=&showLimit=&fromName=&history=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "false", + "description": "Whether to include dropped schemas that have not yet been purged. Default: `false`." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas?like=&startsWith=&showLimit=&fromName=&history=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "false", + "description": "Whether to include dropped schemas that have not yet been purged. Default: `false`." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas?like=&startsWith=&showLimit=&fromName=&history=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "false", + "description": "Whether to include dropped schemas that have not yet been purged. Default: `false`." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas?like=&startsWith=&showLimit=&fromName=&history=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "false", + "description": "Whether to include dropped schemas that have not yet been purged. Default: `false`." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "Creates a schema.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"VKw97w4S60y\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of schema to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ], + "variable": [ + { + "key": "database", + "value": "F7o", + "description": "(Required) 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." + } + ] + }, + "description": "Creates a schema, with modifiers as query parameters. You must provide the full schema definition when creating a schema." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"VKw97w4S60y\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of schema to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"VKw97w4S60y\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of schema to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"VKw97w4S60y\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of schema to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"VKw97w4S60y\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of schema to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"VKw97w4S60y\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of schema to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"VKw97w4S60y\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of schema to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"VKw97w4S60y\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of schema to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"VKw97w4S60y\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of schema to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"VKw97w4S60y\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of schema to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"VKw97w4S60y\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of schema to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"VKw97w4S60y\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of schema to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"VKw97w4S60y\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of schema to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"VKw97w4S60y\",\n \"created_on\": \"\",\n \"kind\": \"PERMANENT\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"database_name\": \"\",\n \"owner\": \"\",\n \"comment\": \"\",\n \"options\": \"\",\n \"managed_access\": false,\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"log_level\": \"\",\n \"pipe_execution_paused\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"trace_level\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas?createMode=errorIfExists&kind=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "kind", + "value": "", + "description": "Type of schema to create. Currently, Snowflake supports only `transient` and `permanent` (also represented by the empty string)." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + }, + { + "key": "name", + "value": "F7o" + }, + { + "key": "name", + "value": "F7o" + } + ] +} \ No newline at end of file diff --git a/public-preview/8.30/collection/Snowflake Services API.postman_collection.json b/public-preview/8.30/collection/Snowflake Services API.postman_collection.json new file mode 100644 index 0000000..c46dffd --- /dev/null +++ b/public-preview/8.30/collection/Snowflake Services API.postman_collection.json @@ -0,0 +1,7328 @@ +{ + "info": { + "_postman_id": "a37566a7-4c8a-4b0c-a8dd-cb6b205d941b", + "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": "28868798", + "_collection_link": "https://snowflake.postman.co/workspace/SnowApi-PuPr~785f3044-d2f3-4a33-8fea-8707898185ed/collection/28868798-a37566a7-4c8a-4b0c-a8dd-cb6b205d941b?action=share&source=collection_link&creator=28868798" + }, + "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=&containerName=&numLines=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "logs" + ], + "query": [ + { + "key": "instanceId", + "value": "", + "description": "(Required) ID of the service instance, starting with 0." + }, + { + "key": "containerName", + "value": "", + "description": "(Required) Container name as specified in the service specification file." + }, + { + "key": "numLines", + "value": "", + "description": "Number of trailing log lines to retrieve." + } + ], + "variable": [ + { + "key": "database", + "value": "wGK3G", + "description": "(Required) 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": "wGK3G", + "description": "(Required) 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": "wGK3G", + "description": "(Required) 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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/logs?instanceId=&containerName=&numLines=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "logs" + ], + "query": [ + { + "key": "instanceId", + "value": "", + "description": "(Required) ID of the service instance, starting with 0." + }, + { + "key": "containerName", + "value": "", + "description": "(Required) Container name as specified in the service specification file." + }, + { + "key": "numLines", + "value": "", + "description": "Number of trailing log lines to retrieve." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"system$get_service_logs\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/logs?instanceId=&containerName=&numLines=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "logs" + ], + "query": [ + { + "key": "instanceId", + "value": "", + "description": "(Required) ID of the service instance, starting with 0." + }, + { + "key": "containerName", + "value": "", + "description": "(Required) Container name as specified in the service specification file." + }, + { + "key": "numLines", + "value": "", + "description": "Number of trailing log lines to retrieve." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/logs?instanceId=&containerName=&numLines=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "logs" + ], + "query": [ + { + "key": "instanceId", + "value": "", + "description": "(Required) ID of the service instance, starting with 0." + }, + { + "key": "containerName", + "value": "", + "description": "(Required) Container name as specified in the service specification file." + }, + { + "key": "numLines", + "value": "", + "description": "Number of trailing log lines to retrieve." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/logs?instanceId=&containerName=&numLines=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "logs" + ], + "query": [ + { + "key": "instanceId", + "value": "", + "description": "(Required) ID of the service instance, starting with 0." + }, + { + "key": "containerName", + "value": "", + "description": "(Required) Container name as specified in the service specification file." + }, + { + "key": "numLines", + "value": "", + "description": "Number of trailing log lines to retrieve." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/logs?instanceId=&containerName=&numLines=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "logs" + ], + "query": [ + { + "key": "instanceId", + "value": "", + "description": "(Required) ID of the service instance, starting with 0." + }, + { + "key": "containerName", + "value": "", + "description": "(Required) Container name as specified in the service specification file." + }, + { + "key": "numLines", + "value": "", + "description": "Number of trailing log lines to retrieve." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/logs?instanceId=&containerName=&numLines=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "logs" + ], + "query": [ + { + "key": "instanceId", + "value": "", + "description": "(Required) ID of the service instance, starting with 0." + }, + { + "key": "containerName", + "value": "", + "description": "(Required) Container name as specified in the service specification file." + }, + { + "key": "numLines", + "value": "", + "description": "Number of trailing log lines to retrieve." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/logs?instanceId=&containerName=&numLines=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "logs" + ], + "query": [ + { + "key": "instanceId", + "value": "", + "description": "(Required) ID of the service instance, starting with 0." + }, + { + "key": "containerName", + "value": "", + "description": "(Required) Container name as specified in the service specification file." + }, + { + "key": "numLines", + "value": "", + "description": "Number of trailing log lines to retrieve." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/logs?instanceId=&containerName=&numLines=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "logs" + ], + "query": [ + { + "key": "instanceId", + "value": "", + "description": "(Required) ID of the service instance, starting with 0." + }, + { + "key": "containerName", + "value": "", + "description": "(Required) Container name as specified in the service specification file." + }, + { + "key": "numLines", + "value": "", + "description": "Number of trailing log lines to retrieve." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/logs?instanceId=&containerName=&numLines=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "logs" + ], + "query": [ + { + "key": "instanceId", + "value": "", + "description": "(Required) ID of the service instance, starting with 0." + }, + { + "key": "containerName", + "value": "", + "description": "(Required) Container name as specified in the service specification file." + }, + { + "key": "numLines", + "value": "", + "description": "Number of trailing log lines to retrieve." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/logs?instanceId=&containerName=&numLines=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "logs" + ], + "query": [ + { + "key": "instanceId", + "value": "", + "description": "(Required) ID of the service instance, starting with 0." + }, + { + "key": "containerName", + "value": "", + "description": "(Required) Container name as specified in the service specification file." + }, + { + "key": "numLines", + "value": "", + "description": "Number of trailing log lines to retrieve." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/logs?instanceId=&containerName=&numLines=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "logs" + ], + "query": [ + { + "key": "instanceId", + "value": "", + "description": "(Required) ID of the service instance, starting with 0." + }, + { + "key": "containerName", + "value": "", + "description": "(Required) Container name as specified in the service specification file." + }, + { + "key": "numLines", + "value": "", + "description": "Number of trailing log lines to retrieve." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "status" + ], + "query": [ + { + "key": "timeout", + "value": "", + "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." + } + ], + "variable": [ + { + "key": "database", + "value": "wGK3G", + "description": "(Required) 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": "wGK3G", + "description": "(Required) 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": "wGK3G", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Fetch the status for a given service." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/status?timeout=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "status" + ], + "query": [ + { + "key": "timeout", + "value": "", + "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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"system$get_service_status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/status?timeout=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "status" + ], + "query": [ + { + "key": "timeout", + "value": "", + "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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/status?timeout=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "status" + ], + "query": [ + { + "key": "timeout", + "value": "", + "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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/status?timeout=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "status" + ], + "query": [ + { + "key": "timeout", + "value": "", + "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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/status?timeout=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "status" + ], + "query": [ + { + "key": "timeout", + "value": "", + "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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/status?timeout=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "status" + ], + "query": [ + { + "key": "timeout", + "value": "", + "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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/status?timeout=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "status" + ], + "query": [ + { + "key": "timeout", + "value": "", + "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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/status?timeout=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "status" + ], + "query": [ + { + "key": "timeout", + "value": "", + "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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/status?timeout=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "status" + ], + "query": [ + { + "key": "timeout", + "value": "", + "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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/status?timeout=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "status" + ], + "query": [ + { + "key": "timeout", + "value": "", + "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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/status?timeout=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "status" + ], + "query": [ + { + "key": "timeout", + "value": "", + "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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "wGK3G", + "description": "(Required) 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": "wGK3G", + "description": "(Required) 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": "wGK3G", + "description": "(Required) 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" + } + ], + "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" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"\",\n \"port\": \"\",\n \"protocol\": \"\",\n \"is_public\": \"\",\n \"ingress_url\": \"\"\n },\n {\n \"name\": \"\",\n \"port\": \"\",\n \"protocol\": \"\",\n \"is_public\": \"\",\n \"ingress_url\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "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" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "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" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "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" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "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" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "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" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "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" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "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" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "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" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "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" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "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" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "wGK3G", + "description": "(Required) 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": "wGK3G", + "description": "(Required) 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": "wGK3G", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Fetch a service." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "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" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"name\": \"hS7ZO\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"query_warehouse\": \"zQXx3HU\",\n \"comment\": \"\",\n \"database_name\": \"OmhjK7pf\",\n \"schema_name\": \"\\\">&.\\\"\\\"\\\"\\\"(NS\\\\3\\\"\\\"\\\"\",\n \"owner\": \"\",\n \"dns_name\": \"\",\n \"created_on\": \"\",\n \"updated_on\": \"\",\n \"resumed_on\": \"\",\n \"owner_role_type\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "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" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "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" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "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" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "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" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "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" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "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" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "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" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "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" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "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" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "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" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database", + "value": "wGK3G", + "description": "(Required) 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": "wGK3G", + "description": "(Required) 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": "wGK3G", + "description": "(Required) 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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database", + "value": "wGK3G", + "description": "(Required) 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": "wGK3G", + "description": "(Required) 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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database", + "value": "wGK3G", + "description": "(Required) 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": "wGK3G", + "description": "(Required) 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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "List services", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database", + "value": "wGK3G", + "description": "(Required) 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": "wGK3G", + "description": "(Required) 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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"xn8Rt2se\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"query_warehouse\": \"qrC\",\n \"comment\": \"\",\n \"database_name\": \"\\\"\\\"\\\"\\\"\\\"9Inns\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema_name\": \"n4v5b\",\n \"owner\": \"\",\n \"dns_name\": \"\",\n \"created_on\": \"\",\n \"updated_on\": \"\",\n \"resumed_on\": \"\",\n \"owner_role_type\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"T4E\\\"\\\"LY\\\"\\\"\\\"\\\"\\\"\\\"`\\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"query_warehouse\": \"_$muWfN1Yi\",\n \"comment\": \"\",\n \"database_name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"5\\\"\\\"j\\\"\\\"$\\\"\",\n \"schema_name\": \"\\\"\\\"\\\":VRj\\\"\\\"n&\\\"\",\n \"owner\": \"\",\n \"dns_name\": \"\",\n \"created_on\": \"\",\n \"updated_on\": \"\",\n \"resumed_on\": \"\",\n \"owner_role_type\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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\": \"hS7ZO\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"query_warehouse\": \"zQXx3HU\",\n \"comment\": \"\",\n \"database_name\": \"OmhjK7pf\",\n \"schema_name\": \"\\\">&.\\\"\\\"\\\"\\\"(NS\\\\3\\\"\\\"\\\"\",\n \"owner\": \"\",\n \"dns_name\": \"\",\n \"created_on\": \"\",\n \"updated_on\": \"\",\n \"resumed_on\": \"\",\n \"owner_role_type\": \"\"\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": [ + { + "key": "createMode", + "value": "errorIfExists", + "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." + } + ], + "variable": [ + { + "key": "database", + "value": "wGK3G", + "description": "(Required) 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": "wGK3G", + "description": "(Required) 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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"hS7ZO\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"query_warehouse\": \"zQXx3HU\",\n \"comment\": \"\",\n \"database_name\": \"OmhjK7pf\",\n \"schema_name\": \"\\\">&.\\\"\\\"\\\"\\\"(NS\\\\3\\\"\\\"\\\"\",\n \"owner\": \"\",\n \"dns_name\": \"\",\n \"created_on\": \"\",\n \"updated_on\": \"\",\n \"resumed_on\": \"\",\n \"owner_role_type\": \"\"\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": [ + { + "key": "createMode", + "value": "errorIfExists", + "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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"hS7ZO\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"query_warehouse\": \"zQXx3HU\",\n \"comment\": \"\",\n \"database_name\": \"OmhjK7pf\",\n \"schema_name\": \"\\\">&.\\\"\\\"\\\"\\\"(NS\\\\3\\\"\\\"\\\"\",\n \"owner\": \"\",\n \"dns_name\": \"\",\n \"created_on\": \"\",\n \"updated_on\": \"\",\n \"resumed_on\": \"\",\n \"owner_role_type\": \"\"\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": [ + { + "key": "createMode", + "value": "errorIfExists", + "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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"hS7ZO\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"query_warehouse\": \"zQXx3HU\",\n \"comment\": \"\",\n \"database_name\": \"OmhjK7pf\",\n \"schema_name\": \"\\\">&.\\\"\\\"\\\"\\\"(NS\\\\3\\\"\\\"\\\"\",\n \"owner\": \"\",\n \"dns_name\": \"\",\n \"created_on\": \"\",\n \"updated_on\": \"\",\n \"resumed_on\": \"\",\n \"owner_role_type\": \"\"\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": [ + { + "key": "createMode", + "value": "errorIfExists", + "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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"hS7ZO\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"query_warehouse\": \"zQXx3HU\",\n \"comment\": \"\",\n \"database_name\": \"OmhjK7pf\",\n \"schema_name\": \"\\\">&.\\\"\\\"\\\"\\\"(NS\\\\3\\\"\\\"\\\"\",\n \"owner\": \"\",\n \"dns_name\": \"\",\n \"created_on\": \"\",\n \"updated_on\": \"\",\n \"resumed_on\": \"\",\n \"owner_role_type\": \"\"\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": [ + { + "key": "createMode", + "value": "errorIfExists", + "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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"hS7ZO\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"query_warehouse\": \"zQXx3HU\",\n \"comment\": \"\",\n \"database_name\": \"OmhjK7pf\",\n \"schema_name\": \"\\\">&.\\\"\\\"\\\"\\\"(NS\\\\3\\\"\\\"\\\"\",\n \"owner\": \"\",\n \"dns_name\": \"\",\n \"created_on\": \"\",\n \"updated_on\": \"\",\n \"resumed_on\": \"\",\n \"owner_role_type\": \"\"\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": [ + { + "key": "createMode", + "value": "errorIfExists", + "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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"hS7ZO\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"query_warehouse\": \"zQXx3HU\",\n \"comment\": \"\",\n \"database_name\": \"OmhjK7pf\",\n \"schema_name\": \"\\\">&.\\\"\\\"\\\"\\\"(NS\\\\3\\\"\\\"\\\"\",\n \"owner\": \"\",\n \"dns_name\": \"\",\n \"created_on\": \"\",\n \"updated_on\": \"\",\n \"resumed_on\": \"\",\n \"owner_role_type\": \"\"\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": [ + { + "key": "createMode", + "value": "errorIfExists", + "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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"hS7ZO\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"query_warehouse\": \"zQXx3HU\",\n \"comment\": \"\",\n \"database_name\": \"OmhjK7pf\",\n \"schema_name\": \"\\\">&.\\\"\\\"\\\"\\\"(NS\\\\3\\\"\\\"\\\"\",\n \"owner\": \"\",\n \"dns_name\": \"\",\n \"created_on\": \"\",\n \"updated_on\": \"\",\n \"resumed_on\": \"\",\n \"owner_role_type\": \"\"\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": [ + { + "key": "createMode", + "value": "errorIfExists", + "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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"hS7ZO\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"query_warehouse\": \"zQXx3HU\",\n \"comment\": \"\",\n \"database_name\": \"OmhjK7pf\",\n \"schema_name\": \"\\\">&.\\\"\\\"\\\"\\\"(NS\\\\3\\\"\\\"\\\"\",\n \"owner\": \"\",\n \"dns_name\": \"\",\n \"created_on\": \"\",\n \"updated_on\": \"\",\n \"resumed_on\": \"\",\n \"owner_role_type\": \"\"\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": [ + { + "key": "createMode", + "value": "errorIfExists", + "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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"hS7ZO\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"query_warehouse\": \"zQXx3HU\",\n \"comment\": \"\",\n \"database_name\": \"OmhjK7pf\",\n \"schema_name\": \"\\\">&.\\\"\\\"\\\"\\\"(NS\\\\3\\\"\\\"\\\"\",\n \"owner\": \"\",\n \"dns_name\": \"\",\n \"created_on\": \"\",\n \"updated_on\": \"\",\n \"resumed_on\": \"\",\n \"owner_role_type\": \"\"\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": [ + { + "key": "createMode", + "value": "errorIfExists", + "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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"hS7ZO\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"query_warehouse\": \"zQXx3HU\",\n \"comment\": \"\",\n \"database_name\": \"OmhjK7pf\",\n \"schema_name\": \"\\\">&.\\\"\\\"\\\"\\\"(NS\\\\3\\\"\\\"\\\"\",\n \"owner\": \"\",\n \"dns_name\": \"\",\n \"created_on\": \"\",\n \"updated_on\": \"\",\n \"resumed_on\": \"\",\n \"owner_role_type\": \"\"\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": [ + { + "key": "createMode", + "value": "errorIfExists", + "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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"hS7ZO\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"query_warehouse\": \"zQXx3HU\",\n \"comment\": \"\",\n \"database_name\": \"OmhjK7pf\",\n \"schema_name\": \"\\\">&.\\\"\\\"\\\"\\\"(NS\\\\3\\\"\\\"\\\"\",\n \"owner\": \"\",\n \"dns_name\": \"\",\n \"created_on\": \"\",\n \"updated_on\": \"\",\n \"resumed_on\": \"\",\n \"owner_role_type\": \"\"\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": [ + { + "key": "createMode", + "value": "errorIfExists", + "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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"hS7ZO\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"query_warehouse\": \"zQXx3HU\",\n \"comment\": \"\",\n \"database_name\": \"OmhjK7pf\",\n \"schema_name\": \"\\\">&.\\\"\\\"\\\"\\\"(NS\\\\3\\\"\\\"\\\"\",\n \"owner\": \"\",\n \"dns_name\": \"\",\n \"created_on\": \"\",\n \"updated_on\": \"\",\n \"resumed_on\": \"\",\n \"owner_role_type\": \"\"\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": [ + { + "key": "createMode", + "value": "errorIfExists", + "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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + }, + { + "key": "name", + "value": "wGK3G" + }, + { + "key": "name", + "value": "wGK3G" + } + ] +} \ No newline at end of file diff --git a/public-preview/8.30/collection/Snowflake Stage API.postman_collection.json b/public-preview/8.30/collection/Snowflake Stage API.postman_collection.json new file mode 100644 index 0000000..756dd88 --- /dev/null +++ b/public-preview/8.30/collection/Snowflake Stage API.postman_collection.json @@ -0,0 +1,4980 @@ +{ + "info": { + "_postman_id": "db0ebc47-192d-4392-a255-b19b0c07bc8c", + "name": "Snowflake Stage API", + "description": "The Snowflake Stage API is a REST API that you can use to access, update, and perform certain actions on stage resources 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": "28868798", + "_collection_link": "https://snowflake.postman.co/workspace/SnowApi-PuPr~785f3044-d2f3-4a33-8fea-8707898185ed/collection/28868798-db0ebc47-192d-4392-a255-b19b0c07bc8c?action=share&source=collection_link&creator=28868798" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "databases", + "item": [ + { + "name": "{database}", + "item": [ + { + "name": "schemas", + "item": [ + { + "name": "{schema}", + "item": [ + { + "name": "stages", + "item": [ + { + "name": "{name}", + "item": [ + { + "name": "files", + "item": [ + { + "name": "{filePath}:presigned-url", + "item": [ + { + "name": "Generate a presigned url and optionally encryption materials.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"mode\": \"download\",\n \"expiration_time\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files/{{filePath}}:presigned-url", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name", + "files", + "{{filePath}}:presigned-url" + ], + "variable": [ + { + "key": "database", + "value": "_kKVEdpwu", + "description": "(Required) 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": "_kKVEdpwu", + "description": "(Required) 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": "_kKVEdpwu", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Generate a presigned url and optionally encryption materials for uploading and downloading files." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"mode\": \"download\",\n \"expiration_time\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files/{{filePath}}:presigned-url", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name", + "files", + "{{filePath}}:presigned-url" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"presigned_url\": \"\",\n \"query_stage_master_key\": \"\",\n \"query_id\": \"\",\n \"smk_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"mode\": \"download\",\n \"expiration_time\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files/{{filePath}}:presigned-url", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name", + "files", + "{{filePath}}:presigned-url" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"mode\": \"download\",\n \"expiration_time\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files/{{filePath}}:presigned-url", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name", + "files", + "{{filePath}}:presigned-url" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"mode\": \"download\",\n \"expiration_time\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files/{{filePath}}:presigned-url", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name", + "files", + "{{filePath}}:presigned-url" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"mode\": \"download\",\n \"expiration_time\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files/{{filePath}}:presigned-url", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name", + "files", + "{{filePath}}:presigned-url" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"mode\": \"download\",\n \"expiration_time\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files/{{filePath}}:presigned-url", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name", + "files", + "{{filePath}}:presigned-url" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"mode\": \"download\",\n \"expiration_time\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files/{{filePath}}:presigned-url", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name", + "files", + "{{filePath}}:presigned-url" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"mode\": \"download\",\n \"expiration_time\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files/{{filePath}}:presigned-url", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name", + "files", + "{{filePath}}:presigned-url" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"mode\": \"download\",\n \"expiration_time\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files/{{filePath}}:presigned-url", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name", + "files", + "{{filePath}}:presigned-url" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"mode\": \"download\",\n \"expiration_time\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files/{{filePath}}:presigned-url", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name", + "files", + "{{filePath}}:presigned-url" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"mode\": \"download\",\n \"expiration_time\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files/{{filePath}}:presigned-url", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name", + "files", + "{{filePath}}:presigned-url" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "List files in the stage.", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files?pattern=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name", + "files" + ], + "query": [ + { + "key": "pattern", + "value": "", + "description": "A query parameter that filters the command output by a regular expression pattern." + } + ], + "variable": [ + { + "key": "database", + "value": "_kKVEdpwu", + "description": "(Required) 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": "_kKVEdpwu", + "description": "(Required) 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": "_kKVEdpwu", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "List files in the stage -- this is equivalent to LIST @stage." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files?pattern=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name", + "files" + ], + "query": [ + { + "key": "pattern", + "value": "", + "description": "A query parameter that filters the command output by a regular expression pattern." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"\",\n \"size\": \"\",\n \"md5\": \"\",\n \"last_modified\": \"\"\n },\n {\n \"name\": \"\",\n \"size\": \"\",\n \"md5\": \"\",\n \"last_modified\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files?pattern=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name", + "files" + ], + "query": [ + { + "key": "pattern", + "value": "", + "description": "A query parameter that filters the command output by a regular expression pattern." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files?pattern=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name", + "files" + ], + "query": [ + { + "key": "pattern", + "value": "", + "description": "A query parameter that filters the command output by a regular expression pattern." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files?pattern=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name", + "files" + ], + "query": [ + { + "key": "pattern", + "value": "", + "description": "A query parameter that filters the command output by a regular expression pattern." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files?pattern=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name", + "files" + ], + "query": [ + { + "key": "pattern", + "value": "", + "description": "A query parameter that filters the command output by a regular expression pattern." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files?pattern=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name", + "files" + ], + "query": [ + { + "key": "pattern", + "value": "", + "description": "A query parameter that filters the command output by a regular expression pattern." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files?pattern=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name", + "files" + ], + "query": [ + { + "key": "pattern", + "value": "", + "description": "A query parameter that filters the command output by a regular expression pattern." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files?pattern=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name", + "files" + ], + "query": [ + { + "key": "pattern", + "value": "", + "description": "A query parameter that filters the command output by a regular expression pattern." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files?pattern=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name", + "files" + ], + "query": [ + { + "key": "pattern", + "value": "", + "description": "A query parameter that filters the command output by a regular expression pattern." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files?pattern=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name", + "files" + ], + "query": [ + { + "key": "pattern", + "value": "", + "description": "A query parameter that filters the command output by a regular expression pattern." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files?pattern=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name", + "files" + ], + "query": [ + { + "key": "pattern", + "value": "", + "description": "A query parameter that filters the command output by a regular expression pattern." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "Fetch a stage", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name" + ], + "variable": [ + { + "key": "database", + "value": "_kKVEdpwu", + "description": "(Required) 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": "_kKVEdpwu", + "description": "(Required) 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": "_kKVEdpwu", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Fetch a stage using the describe command output." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"name\": \"\\\"\\\"\\\"eyb2\\\"\\\"\\\"\\\"\\\"\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"\\\"I\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"%x\\\"\",\n \"comment\": \"\",\n \"credentials\": {\n \"credential_type\": \"\"\n },\n \"encryption\": {\n \"type\": \"AZURE_CSE\",\n \"master_key\": \"\",\n \"kms_key_id\": \"\"\n },\n \"directory_table\": {\n \"enable\": false,\n \"refresh_on_create\": true,\n \"auto_refresh\": false,\n \"notification_integration\": \"\"\n },\n \"created_on\": \"\",\n \"has_credentials\": \"\",\n \"has_encryption_key\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"region\": \"\",\n \"cloud\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "Delete a stage", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database", + "value": "_kKVEdpwu", + "description": "(Required) 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": "_kKVEdpwu", + "description": "(Required) 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": "_kKVEdpwu", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Delete a stage with the stage 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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "List stages", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database", + "value": "_kKVEdpwu", + "description": "(Required) 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": "_kKVEdpwu", + "description": "(Required) 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 stages under the database and schema, with show options as query parameters." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"M0yyWGY2e\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"\\\"R\\\"\\\"\\\"\",\n \"comment\": \"\",\n \"credentials\": {\n \"credential_type\": \"\"\n },\n \"encryption\": {\n \"type\": \"AWS_SSE_KMS\",\n \"master_key\": \"\",\n \"kms_key_id\": \"\"\n },\n \"directory_table\": {\n \"enable\": false,\n \"refresh_on_create\": true,\n \"auto_refresh\": false,\n \"notification_integration\": \"\"\n },\n \"created_on\": \"\",\n \"has_credentials\": \"\",\n \"has_encryption_key\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"region\": \"\",\n \"cloud\": \"\"\n },\n {\n \"name\": \"jF\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"\\\"Xa6\\\"\\\">\\\"\",\n \"comment\": \"\",\n \"credentials\": {\n \"credential_type\": \"\"\n },\n \"encryption\": {\n \"type\": \"NONE\",\n \"master_key\": \"\",\n \"kms_key_id\": \"\"\n },\n \"directory_table\": {\n \"enable\": false,\n \"refresh_on_create\": true,\n \"auto_refresh\": false,\n \"notification_integration\": \"\"\n },\n \"created_on\": \"\",\n \"has_credentials\": \"\",\n \"has_encryption_key\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"region\": \"\",\n \"cloud\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "Create a stage", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"eyb2\\\"\\\"\\\"\\\"\\\"\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"\\\"I\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"%x\\\"\",\n \"comment\": \"\",\n \"credentials\": {\n \"credential_type\": \"\"\n },\n \"encryption\": {\n \"type\": \"AZURE_CSE\",\n \"master_key\": \"\",\n \"kms_key_id\": \"\"\n },\n \"directory_table\": {\n \"enable\": false,\n \"refresh_on_create\": true,\n \"auto_refresh\": false,\n \"notification_integration\": \"\"\n },\n \"created_on\": \"\",\n \"has_credentials\": \"\",\n \"has_encryption_key\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"region\": \"\",\n \"cloud\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database", + "value": "_kKVEdpwu", + "description": "(Required) 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": "_kKVEdpwu", + "description": "(Required) 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 stage, with standard create modifiers as query parameters. See the Stage 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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"eyb2\\\"\\\"\\\"\\\"\\\"\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"\\\"I\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"%x\\\"\",\n \"comment\": \"\",\n \"credentials\": {\n \"credential_type\": \"\"\n },\n \"encryption\": {\n \"type\": \"AZURE_CSE\",\n \"master_key\": \"\",\n \"kms_key_id\": \"\"\n },\n \"directory_table\": {\n \"enable\": false,\n \"refresh_on_create\": true,\n \"auto_refresh\": false,\n \"notification_integration\": \"\"\n },\n \"created_on\": \"\",\n \"has_credentials\": \"\",\n \"has_encryption_key\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"region\": \"\",\n \"cloud\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"eyb2\\\"\\\"\\\"\\\"\\\"\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"\\\"I\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"%x\\\"\",\n \"comment\": \"\",\n \"credentials\": {\n \"credential_type\": \"\"\n },\n \"encryption\": {\n \"type\": \"AZURE_CSE\",\n \"master_key\": \"\",\n \"kms_key_id\": \"\"\n },\n \"directory_table\": {\n \"enable\": false,\n \"refresh_on_create\": true,\n \"auto_refresh\": false,\n \"notification_integration\": \"\"\n },\n \"created_on\": \"\",\n \"has_credentials\": \"\",\n \"has_encryption_key\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"region\": \"\",\n \"cloud\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"eyb2\\\"\\\"\\\"\\\"\\\"\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"\\\"I\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"%x\\\"\",\n \"comment\": \"\",\n \"credentials\": {\n \"credential_type\": \"\"\n },\n \"encryption\": {\n \"type\": \"AZURE_CSE\",\n \"master_key\": \"\",\n \"kms_key_id\": \"\"\n },\n \"directory_table\": {\n \"enable\": false,\n \"refresh_on_create\": true,\n \"auto_refresh\": false,\n \"notification_integration\": \"\"\n },\n \"created_on\": \"\",\n \"has_credentials\": \"\",\n \"has_encryption_key\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"region\": \"\",\n \"cloud\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"eyb2\\\"\\\"\\\"\\\"\\\"\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"\\\"I\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"%x\\\"\",\n \"comment\": \"\",\n \"credentials\": {\n \"credential_type\": \"\"\n },\n \"encryption\": {\n \"type\": \"AZURE_CSE\",\n \"master_key\": \"\",\n \"kms_key_id\": \"\"\n },\n \"directory_table\": {\n \"enable\": false,\n \"refresh_on_create\": true,\n \"auto_refresh\": false,\n \"notification_integration\": \"\"\n },\n \"created_on\": \"\",\n \"has_credentials\": \"\",\n \"has_encryption_key\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"region\": \"\",\n \"cloud\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"eyb2\\\"\\\"\\\"\\\"\\\"\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"\\\"I\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"%x\\\"\",\n \"comment\": \"\",\n \"credentials\": {\n \"credential_type\": \"\"\n },\n \"encryption\": {\n \"type\": \"AZURE_CSE\",\n \"master_key\": \"\",\n \"kms_key_id\": \"\"\n },\n \"directory_table\": {\n \"enable\": false,\n \"refresh_on_create\": true,\n \"auto_refresh\": false,\n \"notification_integration\": \"\"\n },\n \"created_on\": \"\",\n \"has_credentials\": \"\",\n \"has_encryption_key\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"region\": \"\",\n \"cloud\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"eyb2\\\"\\\"\\\"\\\"\\\"\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"\\\"I\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"%x\\\"\",\n \"comment\": \"\",\n \"credentials\": {\n \"credential_type\": \"\"\n },\n \"encryption\": {\n \"type\": \"AZURE_CSE\",\n \"master_key\": \"\",\n \"kms_key_id\": \"\"\n },\n \"directory_table\": {\n \"enable\": false,\n \"refresh_on_create\": true,\n \"auto_refresh\": false,\n \"notification_integration\": \"\"\n },\n \"created_on\": \"\",\n \"has_credentials\": \"\",\n \"has_encryption_key\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"region\": \"\",\n \"cloud\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"eyb2\\\"\\\"\\\"\\\"\\\"\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"\\\"I\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"%x\\\"\",\n \"comment\": \"\",\n \"credentials\": {\n \"credential_type\": \"\"\n },\n \"encryption\": {\n \"type\": \"AZURE_CSE\",\n \"master_key\": \"\",\n \"kms_key_id\": \"\"\n },\n \"directory_table\": {\n \"enable\": false,\n \"refresh_on_create\": true,\n \"auto_refresh\": false,\n \"notification_integration\": \"\"\n },\n \"created_on\": \"\",\n \"has_credentials\": \"\",\n \"has_encryption_key\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"region\": \"\",\n \"cloud\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"eyb2\\\"\\\"\\\"\\\"\\\"\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"\\\"I\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"%x\\\"\",\n \"comment\": \"\",\n \"credentials\": {\n \"credential_type\": \"\"\n },\n \"encryption\": {\n \"type\": \"AZURE_CSE\",\n \"master_key\": \"\",\n \"kms_key_id\": \"\"\n },\n \"directory_table\": {\n \"enable\": false,\n \"refresh_on_create\": true,\n \"auto_refresh\": false,\n \"notification_integration\": \"\"\n },\n \"created_on\": \"\",\n \"has_credentials\": \"\",\n \"has_encryption_key\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"region\": \"\",\n \"cloud\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"eyb2\\\"\\\"\\\"\\\"\\\"\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"\\\"I\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"%x\\\"\",\n \"comment\": \"\",\n \"credentials\": {\n \"credential_type\": \"\"\n },\n \"encryption\": {\n \"type\": \"AZURE_CSE\",\n \"master_key\": \"\",\n \"kms_key_id\": \"\"\n },\n \"directory_table\": {\n \"enable\": false,\n \"refresh_on_create\": true,\n \"auto_refresh\": false,\n \"notification_integration\": \"\"\n },\n \"created_on\": \"\",\n \"has_credentials\": \"\",\n \"has_encryption_key\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"region\": \"\",\n \"cloud\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"eyb2\\\"\\\"\\\"\\\"\\\"\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"\\\"I\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"%x\\\"\",\n \"comment\": \"\",\n \"credentials\": {\n \"credential_type\": \"\"\n },\n \"encryption\": {\n \"type\": \"AZURE_CSE\",\n \"master_key\": \"\",\n \"kms_key_id\": \"\"\n },\n \"directory_table\": {\n \"enable\": false,\n \"refresh_on_create\": true,\n \"auto_refresh\": false,\n \"notification_integration\": \"\"\n },\n \"created_on\": \"\",\n \"has_credentials\": \"\",\n \"has_encryption_key\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"region\": \"\",\n \"cloud\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"eyb2\\\"\\\"\\\"\\\"\\\"\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"\\\"I\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"%x\\\"\",\n \"comment\": \"\",\n \"credentials\": {\n \"credential_type\": \"\"\n },\n \"encryption\": {\n \"type\": \"AZURE_CSE\",\n \"master_key\": \"\",\n \"kms_key_id\": \"\"\n },\n \"directory_table\": {\n \"enable\": false,\n \"refresh_on_create\": true,\n \"auto_refresh\": false,\n \"notification_integration\": \"\"\n },\n \"created_on\": \"\",\n \"has_credentials\": \"\",\n \"has_encryption_key\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"region\": \"\",\n \"cloud\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"eyb2\\\"\\\"\\\"\\\"\\\"\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"\\\"I\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"%x\\\"\",\n \"comment\": \"\",\n \"credentials\": {\n \"credential_type\": \"\"\n },\n \"encryption\": {\n \"type\": \"AZURE_CSE\",\n \"master_key\": \"\",\n \"kms_key_id\": \"\"\n },\n \"directory_table\": {\n \"enable\": false,\n \"refresh_on_create\": true,\n \"auto_refresh\": false,\n \"notification_integration\": \"\"\n },\n \"created_on\": \"\",\n \"has_credentials\": \"\",\n \"has_encryption_key\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"region\": \"\",\n \"cloud\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "stages" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + }, + { + "key": "filePath", + "value": "" + } + ] +} \ No newline at end of file diff --git a/public-preview/8.30/collection/Snowflake Table API.postman_collection.json b/public-preview/8.30/collection/Snowflake Table API.postman_collection.json new file mode 100644 index 0000000..1f0d53a --- /dev/null +++ b/public-preview/8.30/collection/Snowflake Table API.postman_collection.json @@ -0,0 +1,19286 @@ +{ + "info": { + "_postman_id": "4117a224-8c51-4b57-b97e-5a34ea375945", + "name": "Snowflake Table API", + "description": "The Snowflake Table API is a REST API that you can use to access, update, and perform certain actions on Tables 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": "28868798", + "_collection_link": "https://snowflake.postman.co/workspace/SnowApi-PuPr~785f3044-d2f3-4a33-8fea-8707898185ed/collection/28868798-4117a224-8c51-4b57-b97e-5a34ea375945?action=share&source=collection_link&creator=28868798" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "databases", + "item": [ + { + "name": "{database}", + "item": [ + { + "name": "schemas", + "item": [ + { + "name": "{schema}", + "item": [ + { + "name": "tables", + "item": [ + { + "name": "{name}:as_select", + "item": [ + { + "name": "Create a table using the result of the specified select query", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:as_select?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:as_select" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL select query to run to set up the table values (and possibly columns)." + } + ], + "variable": [ + { + "key": "database", + "value": "m", + "description": "(Required) 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": "m", + "description": "(Required) 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 table as select." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:as_select?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:as_select" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL select query to run to set up the table values (and possibly columns)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:as_select?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:as_select" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL select query to run to set up the table values (and possibly columns)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:as_select?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:as_select" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL select query to run to set up the table values (and possibly columns)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:as_select?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:as_select" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL select query to run to set up the table values (and possibly columns)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:as_select?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:as_select" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL select query to run to set up the table values (and possibly columns)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:as_select?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:as_select" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL select query to run to set up the table values (and possibly columns)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:as_select?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:as_select" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL select query to run to set up the table values (and possibly columns)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:as_select?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:as_select" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL select query to run to set up the table values (and possibly columns)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:as_select?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:as_select" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL select query to run to set up the table values (and possibly columns)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:as_select?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:as_select" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL select query to run to set up the table values (and possibly columns)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:as_select?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:as_select" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL select query to run to set up the table values (and possibly columns)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:as_select?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:as_select" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL select query to run to set up the table values (and possibly columns)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:as_select?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:as_select" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL select query to run to set up the table values (and possibly columns)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:using_template", + "item": [ + { + "name": "Create a table using the templates specified in staged files", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:using_template?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:using_template" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL query that uses INFER_SCHEMA on staged files to set the column definitions for the new table." + } + ], + "variable": [ + { + "key": "database", + "value": "m", + "description": "(Required) 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": "m", + "description": "(Required) 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 table using template." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:using_template?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:using_template" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL query that uses INFER_SCHEMA on staged files to set the column definitions for the new table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:using_template?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:using_template" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL query that uses INFER_SCHEMA on staged files to set the column definitions for the new table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:using_template?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:using_template" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL query that uses INFER_SCHEMA on staged files to set the column definitions for the new table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:using_template?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:using_template" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL query that uses INFER_SCHEMA on staged files to set the column definitions for the new table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:using_template?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:using_template" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL query that uses INFER_SCHEMA on staged files to set the column definitions for the new table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:using_template?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:using_template" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL query that uses INFER_SCHEMA on staged files to set the column definitions for the new table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:using_template?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:using_template" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL query that uses INFER_SCHEMA on staged files to set the column definitions for the new table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:using_template?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:using_template" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL query that uses INFER_SCHEMA on staged files to set the column definitions for the new table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:using_template?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:using_template" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL query that uses INFER_SCHEMA on staged files to set the column definitions for the new table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:using_template?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:using_template" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL query that uses INFER_SCHEMA on staged files to set the column definitions for the new table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:using_template?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:using_template" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL query that uses INFER_SCHEMA on staged files to set the column definitions for the new table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:using_template?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:using_template" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL query that uses INFER_SCHEMA on staged files to set the column definitions for the new table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:using_template?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:using_template" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL query that uses INFER_SCHEMA on staged files to set the column definitions for the new table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}", + "item": [ + { + "name": "Fetch a table.", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "variable": [ + { + "key": "database", + "value": "m", + "description": "(Required) 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": "m", + "description": "(Required) 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": "m", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Fetch a Table using the describe command output." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "Create a (or alter an existing) table.", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "variable": [ + { + "key": "database", + "value": "m", + "description": "(Required) 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": "m", + "description": "(Required) 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": "m", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Create a (or alter an existing) table. 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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "Delete a table", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database", + "value": "m", + "description": "(Required) 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": "m", + "description": "(Required) 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": "m", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Delete a table with the given name." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:clone", + "item": [ + { + "name": "Clone table", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"magna\",\n \"reference\": \"veniam fugiat\"\n },\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=m&targetSchema=m", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "targetDatabase", + "value": "m", + "description": "Database of the newly created table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "m", + "description": "Schema of the newly created table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database", + "value": "m", + "description": "(Required) 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": "m", + "description": "(Required) 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 new table by cloning from the specified resource" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"magna\",\n \"reference\": \"veniam fugiat\"\n },\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=m&targetSchema=m", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "targetDatabase", + "value": "m", + "description": "Database of the newly created table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "m", + "description": "Schema of the newly created table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"magna\",\n \"reference\": \"veniam fugiat\"\n },\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=m&targetSchema=m", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "targetDatabase", + "value": "m", + "description": "Database of the newly created table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "m", + "description": "Schema of the newly created table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"magna\",\n \"reference\": \"veniam fugiat\"\n },\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=m&targetSchema=m", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "targetDatabase", + "value": "m", + "description": "Database of the newly created table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "m", + "description": "Schema of the newly created table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"magna\",\n \"reference\": \"veniam fugiat\"\n },\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=m&targetSchema=m", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "targetDatabase", + "value": "m", + "description": "Database of the newly created table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "m", + "description": "Schema of the newly created table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"magna\",\n \"reference\": \"veniam fugiat\"\n },\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=m&targetSchema=m", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "targetDatabase", + "value": "m", + "description": "Database of the newly created table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "m", + "description": "Schema of the newly created table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"magna\",\n \"reference\": \"veniam fugiat\"\n },\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=m&targetSchema=m", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "targetDatabase", + "value": "m", + "description": "Database of the newly created table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "m", + "description": "Schema of the newly created table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"magna\",\n \"reference\": \"veniam fugiat\"\n },\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=m&targetSchema=m", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "targetDatabase", + "value": "m", + "description": "Database of the newly created table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "m", + "description": "Schema of the newly created table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"magna\",\n \"reference\": \"veniam fugiat\"\n },\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=m&targetSchema=m", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "targetDatabase", + "value": "m", + "description": "Database of the newly created table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "m", + "description": "Schema of the newly created table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"magna\",\n \"reference\": \"veniam fugiat\"\n },\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=m&targetSchema=m", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "targetDatabase", + "value": "m", + "description": "Database of the newly created table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "m", + "description": "Schema of the newly created table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"magna\",\n \"reference\": \"veniam fugiat\"\n },\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=m&targetSchema=m", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "targetDatabase", + "value": "m", + "description": "Database of the newly created table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "m", + "description": "Schema of the newly created table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"magna\",\n \"reference\": \"veniam fugiat\"\n },\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=m&targetSchema=m", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "targetDatabase", + "value": "m", + "description": "Database of the newly created table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "m", + "description": "Schema of the newly created table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"magna\",\n \"reference\": \"veniam fugiat\"\n },\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=m&targetSchema=m", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "targetDatabase", + "value": "m", + "description": "Database of the newly created table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "m", + "description": "Schema of the newly created table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"magna\",\n \"reference\": \"veniam fugiat\"\n },\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=m&targetSchema=m", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:clone" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "targetDatabase", + "value": "m", + "description": "Database of the newly created table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "m", + "description": "Schema of the newly created table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:create_like", + "item": [ + { + "name": "Create a table like this existing one", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:create_like?createMode=errorIfExists©Grants=false&newTableName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:create_like" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "newTableName", + "value": "", + "description": "(Required) The name of the table to be created." + } + ], + "variable": [ + { + "key": "database", + "value": "m", + "description": "(Required) 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": "m", + "description": "(Required) 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 new table like the specified resource, but empty" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:create_like?createMode=errorIfExists©Grants=false&newTableName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:create_like" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "newTableName", + "value": "", + "description": "(Required) The name of the table to be created." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:create_like?createMode=errorIfExists©Grants=false&newTableName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:create_like" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "newTableName", + "value": "", + "description": "(Required) The name of the table to be created." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:create_like?createMode=errorIfExists©Grants=false&newTableName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:create_like" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "newTableName", + "value": "", + "description": "(Required) The name of the table to be created." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:create_like?createMode=errorIfExists©Grants=false&newTableName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:create_like" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "newTableName", + "value": "", + "description": "(Required) The name of the table to be created." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:create_like?createMode=errorIfExists©Grants=false&newTableName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:create_like" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "newTableName", + "value": "", + "description": "(Required) The name of the table to be created." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:create_like?createMode=errorIfExists©Grants=false&newTableName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:create_like" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "newTableName", + "value": "", + "description": "(Required) The name of the table to be created." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:create_like?createMode=errorIfExists©Grants=false&newTableName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:create_like" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "newTableName", + "value": "", + "description": "(Required) The name of the table to be created." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:create_like?createMode=errorIfExists©Grants=false&newTableName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:create_like" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "newTableName", + "value": "", + "description": "(Required) The name of the table to be created." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:create_like?createMode=errorIfExists©Grants=false&newTableName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:create_like" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "newTableName", + "value": "", + "description": "(Required) The name of the table to be created." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:create_like?createMode=errorIfExists©Grants=false&newTableName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:create_like" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "newTableName", + "value": "", + "description": "(Required) The name of the table to be created." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:create_like?createMode=errorIfExists©Grants=false&newTableName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:create_like" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "newTableName", + "value": "", + "description": "(Required) The name of the table to be created." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:create_like?createMode=errorIfExists©Grants=false&newTableName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:create_like" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "newTableName", + "value": "", + "description": "(Required) The name of the table to be created." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:create_like?createMode=errorIfExists©Grants=false&newTableName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:create_like" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "newTableName", + "value": "", + "description": "(Required) The name of the table to be created." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:create-like", + "item": [ + { + "name": "Create a table like this existing one", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:create-like?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:create-like" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + } + ], + "variable": [ + { + "key": "database", + "value": "m", + "description": "(Required) 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": "m", + "description": "(Required) 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 new table like the specified resource, but empty" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:create-like?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:create-like" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:create-like?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:create-like" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:create-like?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:create-like" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:create-like?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:create-like" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:create-like?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:create-like" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:create-like?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:create-like" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:create-like?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:create-like" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:create-like?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:create-like" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:create-like?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:create-like" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:create-like?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:create-like" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:create-like?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:create-like" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:create-like?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:create-like" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:create-like?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:create-like" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:undrop", + "item": [ + { + "name": "Undrop a table", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database", + "value": "m", + "description": "(Required) 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": "m", + "description": "(Required) 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": "Undrop specified table" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:suspend_recluster", + "item": [ + { + "name": "Suspend recluster of a table", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:suspend_recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:suspend_recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database", + "value": "m", + "description": "(Required) 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": "m", + "description": "(Required) 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 recluster of a table" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:suspend_recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:suspend_recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:suspend_recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:suspend_recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:suspend_recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:suspend_recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:suspend_recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:suspend_recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:suspend_recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:suspend_recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:suspend_recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:suspend_recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:suspend_recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:suspend_recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:suspend_recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:suspend_recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:suspend_recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:suspend_recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:suspend_recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:suspend_recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:suspend_recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:suspend_recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:suspend_recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:suspend_recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:suspend_recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:suspend_recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:suspend-recluster", + "item": [ + { + "name": "Suspend recluster of a table", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:suspend-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:suspend-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database", + "value": "m", + "description": "(Required) 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": "m", + "description": "(Required) 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 recluster of a table" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:suspend-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:suspend-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:suspend-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:suspend-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:suspend-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:suspend-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:suspend-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:suspend-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:suspend-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:suspend-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:suspend-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:suspend-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:suspend-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:suspend-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:suspend-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:suspend-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:suspend-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:suspend-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:suspend-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:suspend-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:suspend-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:suspend-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:suspend-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:suspend-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:suspend-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:suspend-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:resume_recluster", + "item": [ + { + "name": "Resume recluster of a table", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:resume_recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:resume_recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database", + "value": "m", + "description": "(Required) 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": "m", + "description": "(Required) 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 recluster of a table" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:resume_recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:resume_recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:resume_recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:resume_recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:resume_recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:resume_recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:resume_recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:resume_recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:resume_recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:resume_recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:resume_recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:resume_recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:resume_recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:resume_recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:resume_recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:resume_recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:resume_recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:resume_recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:resume_recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:resume_recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:resume_recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:resume_recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:resume_recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:resume_recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:resume_recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:resume_recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:resume-recluster", + "item": [ + { + "name": "Resume recluster of a table", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:resume-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:resume-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database", + "value": "m", + "description": "(Required) 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": "m", + "description": "(Required) 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 recluster of a table" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:resume-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:resume-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:resume-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:resume-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:resume-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:resume-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:resume-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:resume-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:resume-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:resume-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:resume-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:resume-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:resume-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:resume-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:resume-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:resume-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:resume-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:resume-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:resume-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:resume-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:resume-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:resume-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:resume-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:resume-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:resume-recluster?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:resume-recluster" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:swapwith", + "item": [ + { + "name": "Swap with another table", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swapwith?ifExists=false&targetTableName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:swapwith" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetTableName", + "value": "", + "description": "(Required) The fully-specified name of the target table to be swapped with." + } + ], + "variable": [ + { + "key": "database", + "value": "m", + "description": "(Required) 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": "m", + "description": "(Required) 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": "Swap with another table" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swapwith?ifExists=false&targetTableName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:swapwith" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetTableName", + "value": "", + "description": "(Required) The fully-specified name of the target table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swapwith?ifExists=false&targetTableName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:swapwith" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetTableName", + "value": "", + "description": "(Required) The fully-specified name of the target table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swapwith?ifExists=false&targetTableName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:swapwith" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetTableName", + "value": "", + "description": "(Required) The fully-specified name of the target table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swapwith?ifExists=false&targetTableName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:swapwith" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetTableName", + "value": "", + "description": "(Required) The fully-specified name of the target table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swapwith?ifExists=false&targetTableName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:swapwith" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetTableName", + "value": "", + "description": "(Required) The fully-specified name of the target table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swapwith?ifExists=false&targetTableName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:swapwith" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetTableName", + "value": "", + "description": "(Required) The fully-specified name of the target table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swapwith?ifExists=false&targetTableName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:swapwith" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetTableName", + "value": "", + "description": "(Required) The fully-specified name of the target table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swapwith?ifExists=false&targetTableName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:swapwith" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetTableName", + "value": "", + "description": "(Required) The fully-specified name of the target table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swapwith?ifExists=false&targetTableName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:swapwith" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetTableName", + "value": "", + "description": "(Required) The fully-specified name of the target table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swapwith?ifExists=false&targetTableName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:swapwith" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetTableName", + "value": "", + "description": "(Required) The fully-specified name of the target table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swapwith?ifExists=false&targetTableName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:swapwith" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetTableName", + "value": "", + "description": "(Required) The fully-specified name of the target table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swapwith?ifExists=false&targetTableName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:swapwith" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetTableName", + "value": "", + "description": "(Required) The fully-specified name of the target table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swapwith?ifExists=false&targetTableName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:swapwith" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetTableName", + "value": "", + "description": "(Required) The fully-specified name of the target table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:swap-with", + "item": [ + { + "name": "Swap with another table", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swap-with?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:swap-with" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetName", + "value": "", + "description": "(Required) The fully-specified name of the target table to be swapped with." + } + ], + "variable": [ + { + "key": "database", + "value": "m", + "description": "(Required) 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": "m", + "description": "(Required) 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": "Swap with another table" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swap-with?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:swap-with" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetName", + "value": "", + "description": "(Required) The fully-specified name of the target table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swap-with?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:swap-with" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetName", + "value": "", + "description": "(Required) The fully-specified name of the target table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swap-with?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:swap-with" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetName", + "value": "", + "description": "(Required) The fully-specified name of the target table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swap-with?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:swap-with" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetName", + "value": "", + "description": "(Required) The fully-specified name of the target table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swap-with?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:swap-with" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetName", + "value": "", + "description": "(Required) The fully-specified name of the target table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swap-with?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:swap-with" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetName", + "value": "", + "description": "(Required) The fully-specified name of the target table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swap-with?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:swap-with" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetName", + "value": "", + "description": "(Required) The fully-specified name of the target table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swap-with?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:swap-with" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetName", + "value": "", + "description": "(Required) The fully-specified name of the target table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swap-with?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:swap-with" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetName", + "value": "", + "description": "(Required) The fully-specified name of the target table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swap-with?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:swap-with" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetName", + "value": "", + "description": "(Required) The fully-specified name of the target table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swap-with?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:swap-with" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetName", + "value": "", + "description": "(Required) The fully-specified name of the target table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swap-with?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:swap-with" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetName", + "value": "", + "description": "(Required) The fully-specified name of the target table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swap-with?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables", + "{{name}}:swap-with" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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": "targetName", + "value": "", + "description": "(Required) The fully-specified name of the target table to be swapped with." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "List tables", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables?like=&startsWith=&showLimit=&fromName=&history=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "", + "description": "Optionally includes dropped tables that have not yet been purged." + }, + { + "key": "deep", + "value": "", + "description": "Optionally includes dependency information of the table." + } + ], + "variable": [ + { + "key": "database", + "value": "m", + "description": "(Required) 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": "m", + "description": "(Required) 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 tables under the database and schema." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables?like=&startsWith=&showLimit=&fromName=&history=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "", + "description": "Optionally includes dropped tables that have not yet been purged." + }, + { + "key": "deep", + "value": "", + "description": "Optionally includes dependency information of the table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n },\n {\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables?like=&startsWith=&showLimit=&fromName=&history=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "", + "description": "Optionally includes dropped tables that have not yet been purged." + }, + { + "key": "deep", + "value": "", + "description": "Optionally includes dependency information of the table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables?like=&startsWith=&showLimit=&fromName=&history=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "", + "description": "Optionally includes dropped tables that have not yet been purged." + }, + { + "key": "deep", + "value": "", + "description": "Optionally includes dependency information of the table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables?like=&startsWith=&showLimit=&fromName=&history=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "", + "description": "Optionally includes dropped tables that have not yet been purged." + }, + { + "key": "deep", + "value": "", + "description": "Optionally includes dependency information of the table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables?like=&startsWith=&showLimit=&fromName=&history=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "", + "description": "Optionally includes dropped tables that have not yet been purged." + }, + { + "key": "deep", + "value": "", + "description": "Optionally includes dependency information of the table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables?like=&startsWith=&showLimit=&fromName=&history=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "", + "description": "Optionally includes dropped tables that have not yet been purged." + }, + { + "key": "deep", + "value": "", + "description": "Optionally includes dependency information of the table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables?like=&startsWith=&showLimit=&fromName=&history=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "", + "description": "Optionally includes dropped tables that have not yet been purged." + }, + { + "key": "deep", + "value": "", + "description": "Optionally includes dependency information of the table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables?like=&startsWith=&showLimit=&fromName=&history=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "", + "description": "Optionally includes dropped tables that have not yet been purged." + }, + { + "key": "deep", + "value": "", + "description": "Optionally includes dependency information of the table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables?like=&startsWith=&showLimit=&fromName=&history=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "", + "description": "Optionally includes dropped tables that have not yet been purged." + }, + { + "key": "deep", + "value": "", + "description": "Optionally includes dependency information of the table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables?like=&startsWith=&showLimit=&fromName=&history=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "", + "description": "Optionally includes dropped tables that have not yet been purged." + }, + { + "key": "deep", + "value": "", + "description": "Optionally includes dependency information of the table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables?like=&startsWith=&showLimit=&fromName=&history=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "", + "description": "Optionally includes dropped tables that have not yet been purged." + }, + { + "key": "deep", + "value": "", + "description": "Optionally includes dependency information of the table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables?like=&startsWith=&showLimit=&fromName=&history=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "", + "description": "Optionally includes dropped tables that have not yet been purged." + }, + { + "key": "deep", + "value": "", + "description": "Optionally includes dependency information of the table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables?like=&startsWith=&showLimit=&fromName=&history=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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": "history", + "value": "", + "description": "Optionally includes dropped tables that have not yet been purged." + }, + { + "key": "deep", + "value": "", + "description": "Optionally includes dependency information of the table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "Create a table (clone and undrop are separate subresources)", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + } + ], + "variable": [ + { + "key": "database", + "value": "m", + "description": "(Required) 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": "m", + "description": "(Required) 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 table." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"kind\": \"PERMANENT\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"enable_schema_evolution\": \"\",\n \"change_tracking\": \"\",\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"default_ddl_collation\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"owner\": \"\",\n \"dropped_on\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"owner_role_type\": \"\",\n \"budget\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "tables:as-select", + "item": [ + { + "name": "Create a table using the result of the specified select query", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"cluster_by\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables:as-select?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables:as-select" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL select query to run to set up the table values (and possibly columns)." + } + ], + "variable": [ + { + "key": "database", + "value": "m", + "description": "(Required) 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": "m", + "description": "(Required) 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 table as select." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"cluster_by\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables:as-select?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables:as-select" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL select query to run to set up the table values (and possibly columns)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"cluster_by\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables:as-select?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables:as-select" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL select query to run to set up the table values (and possibly columns)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"cluster_by\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables:as-select?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables:as-select" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL select query to run to set up the table values (and possibly columns)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"cluster_by\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables:as-select?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables:as-select" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL select query to run to set up the table values (and possibly columns)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"cluster_by\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables:as-select?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables:as-select" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL select query to run to set up the table values (and possibly columns)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"cluster_by\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables:as-select?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables:as-select" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL select query to run to set up the table values (and possibly columns)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"cluster_by\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables:as-select?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables:as-select" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL select query to run to set up the table values (and possibly columns)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"cluster_by\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables:as-select?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables:as-select" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL select query to run to set up the table values (and possibly columns)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"cluster_by\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables:as-select?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables:as-select" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL select query to run to set up the table values (and possibly columns)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"cluster_by\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables:as-select?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables:as-select" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL select query to run to set up the table values (and possibly columns)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"cluster_by\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables:as-select?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables:as-select" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL select query to run to set up the table values (and possibly columns)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"cluster_by\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables:as-select?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables:as-select" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL select query to run to set up the table values (and possibly columns)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": true,\n \"collate\": \"\",\n \"default\": \"\",\n \"autoincrement\": \"\",\n \"autoincrement_start\": \"\",\n \"autoincrement_increment\": \"\",\n \"constraints\": [\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n },\n {\n \"name\": \"\",\n \"column_names\": [\n \"\",\n \"\"\n ],\n \"constraint_type\": \"\"\n }\n ],\n \"comment\": \"\"\n }\n ],\n \"cluster_by\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables:as-select?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables:as-select" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL select query to run to set up the table values (and possibly columns)." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "tables:using-template", + "item": [ + { + "name": "Create a table using the templates specified in staged files", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables:using-template?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables:using-template" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL query that uses INFER_SCHEMA on staged files to set the column definitions for the new table." + } + ], + "variable": [ + { + "key": "database", + "value": "m", + "description": "(Required) 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": "m", + "description": "(Required) 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 table using template." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables:using-template?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables:using-template" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL query that uses INFER_SCHEMA on staged files to set the column definitions for the new table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables:using-template?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables:using-template" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL query that uses INFER_SCHEMA on staged files to set the column definitions for the new table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables:using-template?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables:using-template" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL query that uses INFER_SCHEMA on staged files to set the column definitions for the new table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables:using-template?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables:using-template" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL query that uses INFER_SCHEMA on staged files to set the column definitions for the new table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables:using-template?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables:using-template" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL query that uses INFER_SCHEMA on staged files to set the column definitions for the new table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables:using-template?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables:using-template" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL query that uses INFER_SCHEMA on staged files to set the column definitions for the new table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables:using-template?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables:using-template" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL query that uses INFER_SCHEMA on staged files to set the column definitions for the new table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables:using-template?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables:using-template" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL query that uses INFER_SCHEMA on staged files to set the column definitions for the new table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables:using-template?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables:using-template" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL query that uses INFER_SCHEMA on staged files to set the column definitions for the new table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables:using-template?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables:using-template" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL query that uses INFER_SCHEMA on staged files to set the column definitions for the new table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables:using-template?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables:using-template" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL query that uses INFER_SCHEMA on staged files to set the column definitions for the new table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables:using-template?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables:using-template" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL query that uses INFER_SCHEMA on staged files to set the column definitions for the new table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables:using-template?createMode=errorIfExists©Grants=false&query=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tables:using-template" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + }, + { + "key": "query", + "value": "", + "description": "(Required) The SQL query that uses INFER_SCHEMA on staged files to set the column definitions for the new table." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + }, + { + "key": "name", + "value": "m" + }, + { + "key": "name", + "value": "m" + }, + { + "key": "name", + "value": "m" + }, + { + "key": "name", + "value": "m" + }, + { + "key": "name", + "value": "m" + }, + { + "key": "name", + "value": "m" + }, + { + "key": "name", + "value": "m" + }, + { + "key": "name", + "value": "m" + }, + { + "key": "name", + "value": "m" + }, + { + "key": "name", + "value": "m" + }, + { + "key": "name", + "value": "m" + }, + { + "key": "name", + "value": "m" + } + ] +} \ No newline at end of file diff --git a/public-preview/8.30/collection/Snowflake Task API.postman_collection.json b/public-preview/8.30/collection/Snowflake Task API.postman_collection.json new file mode 100644 index 0000000..eb509da --- /dev/null +++ b/public-preview/8.30/collection/Snowflake Task API.postman_collection.json @@ -0,0 +1,10546 @@ +{ + "info": { + "_postman_id": "186eeb58-134a-4fb3-be44-d1b9cb799584", + "name": "Snowflake Task API", + "description": "The Snowflake Task API is a REST API that you can use to access, update, and perform certain actions on task resources 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": "28868798", + "_collection_link": "https://snowflake.postman.co/workspace/SnowApi-PuPr~785f3044-d2f3-4a33-8fea-8707898185ed/collection/28868798-186eeb58-134a-4fb3-be44-d1b9cb799584?action=share&source=collection_link&creator=28868798" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "databases", + "item": [ + { + "name": "{database}", + "item": [ + { + "name": "schemas", + "item": [ + { + "name": "{schema}", + "item": [ + { + "name": "tasks", + "item": [ + { + "name": "{name}", + "item": [ + { + "name": "dependents", + "item": [ + { + "name": "Fetch the dependent tasks of a task", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/dependents?recursive=true", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "dependents" + ], + "query": [ + { + "key": "recursive", + "value": "true", + "description": "Specifies whether to limit the output to include only direct child tasks or to include all recursive child tasks." + } + ], + "variable": [ + { + "key": "database", + "value": "\"Fq\"\" \"\"\"", + "description": "(Required) 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": "\"Fq\"\" \"\"\"", + "description": "(Required) 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": "\"Fq\"\" \"\"\"", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "This operation returns a list of the dependent tasks of the task with identifier {name}." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/dependents?recursive=true", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "dependents" + ], + "query": [ + { + "key": "recursive", + "value": "true", + "description": "Specifies whether to limit the output to include only direct child tasks or to include all recursive child tasks." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"\\\"\\\"\\\"p!p\\\"\\\"-\\\"\\\"\\\"\\\"#\\\"\\\"a\\\"\",\n \"definition\": \"\",\n \"warehouse\": \"c\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"in7_f\": true,\n \"cillumfb\": false\n },\n \"session_parameters\": {\n \"veniam_91\": 98356371\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\n \"task_relations\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"condition\": \"\",\n \"allow_overlapping_execution\": \"\",\n \"error_integration\": \"\",\n \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n },\n {\n \"name\": \"\\\"w\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"definition\": \"\",\n \"warehouse\": \"NgTV\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"Utee1\": 45254644,\n \"cillum__e\": true\n },\n \"session_parameters\": {\n \"consequat_df\": -7845971\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\n \"task_relations\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"condition\": \"\",\n \"allow_overlapping_execution\": \"\",\n \"error_integration\": \"\",\n \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/dependents?recursive=true", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "dependents" + ], + "query": [ + { + "key": "recursive", + "value": "true", + "description": "Specifies whether to limit the output to include only direct child tasks or to include all recursive child tasks." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/dependents?recursive=true", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "dependents" + ], + "query": [ + { + "key": "recursive", + "value": "true", + "description": "Specifies whether to limit the output to include only direct child tasks or to include all recursive child tasks." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/dependents?recursive=true", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "dependents" + ], + "query": [ + { + "key": "recursive", + "value": "true", + "description": "Specifies whether to limit the output to include only direct child tasks or to include all recursive child tasks." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/dependents?recursive=true", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "dependents" + ], + "query": [ + { + "key": "recursive", + "value": "true", + "description": "Specifies whether to limit the output to include only direct child tasks or to include all recursive child tasks." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/dependents?recursive=true", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "dependents" + ], + "query": [ + { + "key": "recursive", + "value": "true", + "description": "Specifies whether to limit the output to include only direct child tasks or to include all recursive child tasks." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/dependents?recursive=true", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "dependents" + ], + "query": [ + { + "key": "recursive", + "value": "true", + "description": "Specifies whether to limit the output to include only direct child tasks or to include all recursive child tasks." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/dependents?recursive=true", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "dependents" + ], + "query": [ + { + "key": "recursive", + "value": "true", + "description": "Specifies whether to limit the output to include only direct child tasks or to include all recursive child tasks." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/dependents?recursive=true", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "dependents" + ], + "query": [ + { + "key": "recursive", + "value": "true", + "description": "Specifies whether to limit the output to include only direct child tasks or to include all recursive child tasks." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/dependents?recursive=true", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "dependents" + ], + "query": [ + { + "key": "recursive", + "value": "true", + "description": "Specifies whether to limit the output to include only direct child tasks or to include all recursive child tasks." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/dependents?recursive=true", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "dependents" + ], + "query": [ + { + "key": "recursive", + "value": "true", + "description": "Specifies whether to limit the output to include only direct child tasks or to include all recursive child tasks." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "current_graphs", + "item": [ + { + "name": "Get the graph runs that are executing or scheduled for the task for the next 8 days.", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current_graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database", + "value": "\"Fq\"\" \"\"\"", + "description": "(Required) 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": "\"Fq\"\" \"\"\"", + "description": "(Required) 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": "\"Fq\"\" \"\"\"", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "This function returns details for graph runs that are currently executing or are next scheduled to run within the next 8 days." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current_graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "[\n {\n \"root_task_name\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"state\": \"SUCCEEDED\",\n \"scheduled_time\": \"\",\n \"next_scheduled_time\": \"\",\n \"root_task_id\": \"\",\n \"graph_version\": \"\",\n \"run_id\": \"\",\n \"first_error_task_name\": \"\",\n \"first_error_code\": \"\",\n \"first_error_message\": \"\",\n \"query_start_time\": \"\",\n \"completed_time\": \"\"\n },\n {\n \"root_task_name\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"state\": \"SCHEDULED\",\n \"scheduled_time\": \"\",\n \"next_scheduled_time\": \"\",\n \"root_task_id\": \"\",\n \"graph_version\": \"\",\n \"run_id\": \"\",\n \"first_error_task_name\": \"\",\n \"first_error_code\": \"\",\n \"first_error_message\": \"\",\n \"query_start_time\": \"\",\n \"completed_time\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current_graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current_graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current_graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current_graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current_graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current_graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current_graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current_graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current_graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current_graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "current-graphs", + "item": [ + { + "name": "Get the graph runs that are executing or scheduled for the task for the next 8 days.", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current-graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current-graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database", + "value": "\"Fq\"\" \"\"\"", + "description": "(Required) 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": "\"Fq\"\" \"\"\"", + "description": "(Required) 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": "\"Fq\"\" \"\"\"", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "This function returns details for graph runs that are currently executing or are next scheduled to run within the next 8 days." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current-graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current-graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"root_task_name\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"state\": \"SUCCEEDED\",\n \"scheduled_time\": \"\",\n \"next_scheduled_time\": \"\",\n \"root_task_id\": \"\",\n \"graph_version\": \"\",\n \"run_id\": \"\",\n \"first_error_task_name\": \"\",\n \"first_error_code\": \"\",\n \"first_error_message\": \"\",\n \"query_start_time\": \"\",\n \"completed_time\": \"\"\n },\n {\n \"root_task_name\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"state\": \"SCHEDULED\",\n \"scheduled_time\": \"\",\n \"next_scheduled_time\": \"\",\n \"root_task_id\": \"\",\n \"graph_version\": \"\",\n \"run_id\": \"\",\n \"first_error_task_name\": \"\",\n \"first_error_code\": \"\",\n \"first_error_message\": \"\",\n \"query_start_time\": \"\",\n \"completed_time\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current-graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current-graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current-graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current-graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current-graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current-graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current-graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current-graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current-graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current-graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current-graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current-graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current-graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current-graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current-graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current-graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current-graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current-graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current-graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current-graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "complete_graphs", + "item": [ + { + "name": "Get the graph runs that are completed for the task.", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete_graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database", + "value": "\"Fq\"\" \"\"\"", + "description": "(Required) 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": "\"Fq\"\" \"\"\"", + "description": "(Required) 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": "\"Fq\"\" \"\"\"", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "This function returns details for graph runs that are completed." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete_graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "[\n {\n \"root_task_name\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"state\": \"SUCCEEDED\",\n \"scheduled_time\": \"\",\n \"next_scheduled_time\": \"\",\n \"root_task_id\": \"\",\n \"graph_version\": \"\",\n \"run_id\": \"\",\n \"first_error_task_name\": \"\",\n \"first_error_code\": \"\",\n \"first_error_message\": \"\",\n \"query_start_time\": \"\",\n \"completed_time\": \"\"\n },\n {\n \"root_task_name\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"state\": \"SCHEDULED\",\n \"scheduled_time\": \"\",\n \"next_scheduled_time\": \"\",\n \"root_task_id\": \"\",\n \"graph_version\": \"\",\n \"run_id\": \"\",\n \"first_error_task_name\": \"\",\n \"first_error_code\": \"\",\n \"first_error_message\": \"\",\n \"query_start_time\": \"\",\n \"completed_time\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete_graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete_graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete_graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete_graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete_graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete_graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete_graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete_graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete_graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete_graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "complete-graphs", + "item": [ + { + "name": "Get the graph runs that are completed for the task.", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete-graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete-graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database", + "value": "\"Fq\"\" \"\"\"", + "description": "(Required) 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": "\"Fq\"\" \"\"\"", + "description": "(Required) 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": "\"Fq\"\" \"\"\"", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "This function returns details for graph runs that are completed." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete-graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete-graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"root_task_name\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"state\": \"SUCCEEDED\",\n \"scheduled_time\": \"\",\n \"next_scheduled_time\": \"\",\n \"root_task_id\": \"\",\n \"graph_version\": \"\",\n \"run_id\": \"\",\n \"first_error_task_name\": \"\",\n \"first_error_code\": \"\",\n \"first_error_message\": \"\",\n \"query_start_time\": \"\",\n \"completed_time\": \"\"\n },\n {\n \"root_task_name\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"state\": \"SCHEDULED\",\n \"scheduled_time\": \"\",\n \"next_scheduled_time\": \"\",\n \"root_task_id\": \"\",\n \"graph_version\": \"\",\n \"run_id\": \"\",\n \"first_error_task_name\": \"\",\n \"first_error_code\": \"\",\n \"first_error_message\": \"\",\n \"query_start_time\": \"\",\n \"completed_time\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete-graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete-graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete-graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete-graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete-graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete-graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete-graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete-graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete-graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete-graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete-graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete-graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete-graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete-graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete-graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete-graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete-graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete-graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete-graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete-graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "Fetch a task", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database", + "value": "\"Fq\"\" \"\"\"", + "description": "(Required) 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": "\"Fq\"\" \"\"\"", + "description": "(Required) 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": "\"Fq\"\" \"\"\"", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Fetch a task using the describe command output." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"name\": \"l\",\n \"definition\": \"\",\n \"warehouse\": \"bBzuom\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"nostrud2_9\": -65835073\n },\n \"session_parameters\": {\n \"voluptate6a2\": 27785958\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\n \"task_relations\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"condition\": \"\",\n \"allow_overlapping_execution\": \"\",\n \"error_integration\": \"\",\n \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "Create a (or alter an existing) task", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"l\",\n \"definition\": \"\",\n \"warehouse\": \"bBzuom\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"nostrud2_9\": -65835073\n },\n \"session_parameters\": {\n \"voluptate6a2\": 27785958\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\n \"task_relations\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"condition\": \"\",\n \"allow_overlapping_execution\": \"\",\n \"error_integration\": \"\",\n \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database", + "value": "\"Fq\"\" \"\"\"", + "description": "(Required) 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": "\"Fq\"\" \"\"\"", + "description": "(Required) 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": "\"Fq\"\" \"\"\"", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Create a (or alter an existing) task. 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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"l\",\n \"definition\": \"\",\n \"warehouse\": \"bBzuom\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"nostrud2_9\": -65835073\n },\n \"session_parameters\": {\n \"voluptate6a2\": 27785958\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\n \"task_relations\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"condition\": \"\",\n \"allow_overlapping_execution\": \"\",\n \"error_integration\": \"\",\n \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"l\",\n \"definition\": \"\",\n \"warehouse\": \"bBzuom\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"nostrud2_9\": -65835073\n },\n \"session_parameters\": {\n \"voluptate6a2\": 27785958\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\n \"task_relations\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"condition\": \"\",\n \"allow_overlapping_execution\": \"\",\n \"error_integration\": \"\",\n \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"l\",\n \"definition\": \"\",\n \"warehouse\": \"bBzuom\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"nostrud2_9\": -65835073\n },\n \"session_parameters\": {\n \"voluptate6a2\": 27785958\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\n \"task_relations\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"condition\": \"\",\n \"allow_overlapping_execution\": \"\",\n \"error_integration\": \"\",\n \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"l\",\n \"definition\": \"\",\n \"warehouse\": \"bBzuom\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"nostrud2_9\": -65835073\n },\n \"session_parameters\": {\n \"voluptate6a2\": 27785958\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\n \"task_relations\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"condition\": \"\",\n \"allow_overlapping_execution\": \"\",\n \"error_integration\": \"\",\n \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"l\",\n \"definition\": \"\",\n \"warehouse\": \"bBzuom\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"nostrud2_9\": -65835073\n },\n \"session_parameters\": {\n \"voluptate6a2\": 27785958\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\n \"task_relations\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"condition\": \"\",\n \"allow_overlapping_execution\": \"\",\n \"error_integration\": \"\",\n \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"l\",\n \"definition\": \"\",\n \"warehouse\": \"bBzuom\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"nostrud2_9\": -65835073\n },\n \"session_parameters\": {\n \"voluptate6a2\": 27785958\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\n \"task_relations\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"condition\": \"\",\n \"allow_overlapping_execution\": \"\",\n \"error_integration\": \"\",\n \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"l\",\n \"definition\": \"\",\n \"warehouse\": \"bBzuom\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"nostrud2_9\": -65835073\n },\n \"session_parameters\": {\n \"voluptate6a2\": 27785958\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\n \"task_relations\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"condition\": \"\",\n \"allow_overlapping_execution\": \"\",\n \"error_integration\": \"\",\n \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"l\",\n \"definition\": \"\",\n \"warehouse\": \"bBzuom\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"nostrud2_9\": -65835073\n },\n \"session_parameters\": {\n \"voluptate6a2\": 27785958\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\n \"task_relations\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"condition\": \"\",\n \"allow_overlapping_execution\": \"\",\n \"error_integration\": \"\",\n \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"l\",\n \"definition\": \"\",\n \"warehouse\": \"bBzuom\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"nostrud2_9\": -65835073\n },\n \"session_parameters\": {\n \"voluptate6a2\": 27785958\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\n \"task_relations\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"condition\": \"\",\n \"allow_overlapping_execution\": \"\",\n \"error_integration\": \"\",\n \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"l\",\n \"definition\": \"\",\n \"warehouse\": \"bBzuom\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"nostrud2_9\": -65835073\n },\n \"session_parameters\": {\n \"voluptate6a2\": 27785958\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\n \"task_relations\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"condition\": \"\",\n \"allow_overlapping_execution\": \"\",\n \"error_integration\": \"\",\n \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"l\",\n \"definition\": \"\",\n \"warehouse\": \"bBzuom\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"nostrud2_9\": -65835073\n },\n \"session_parameters\": {\n \"voluptate6a2\": 27785958\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\n \"task_relations\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"condition\": \"\",\n \"allow_overlapping_execution\": \"\",\n \"error_integration\": \"\",\n \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "Delete a task", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database", + "value": "\"Fq\"\" \"\"\"", + "description": "(Required) 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": "\"Fq\"\" \"\"\"", + "description": "(Required) 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": "\"Fq\"\" \"\"\"", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Delete a task with the task 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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:execute", + "item": [ + { + "name": "Execute a task object.", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "retryLast", + "value": "false", + "description": "Retry the last failed run of the DAG." + } + ], + "variable": [ + { + "key": "database", + "value": "\"Fq\"\" \"\"\"", + "description": "(Required) 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": "\"Fq\"\" \"\"\"", + "description": "(Required) 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": "Execute a task -- this is equivalent to EXECUTE IMMEDIATE." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "retryLast", + "value": "false", + "description": "Retry the last failed run of the DAG." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "retryLast", + "value": "false", + "description": "Retry the last failed run of the DAG." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "retryLast", + "value": "false", + "description": "Retry the last failed run of the DAG." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "retryLast", + "value": "false", + "description": "Retry the last failed run of the DAG." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "retryLast", + "value": "false", + "description": "Retry the last failed run of the DAG." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "retryLast", + "value": "false", + "description": "Retry the last failed run of the DAG." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "retryLast", + "value": "false", + "description": "Retry the last failed run of the DAG." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "retryLast", + "value": "false", + "description": "Retry the last failed run of the DAG." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "retryLast", + "value": "false", + "description": "Retry the last failed run of the DAG." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "retryLast", + "value": "false", + "description": "Retry the last failed run of the DAG." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "retryLast", + "value": "false", + "description": "Retry the last failed run of the DAG." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:resume", + "item": [ + { + "name": "Resume a suspended task.", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:resume" + ], + "variable": [ + { + "key": "database", + "value": "\"Fq\"\" \"\"\"", + "description": "(Required) 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": "\"Fq\"\" \"\"\"", + "description": "(Required) 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": "Resumes a suspended task object. This is equivalento an ALTER TASK ... RESUME." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:resume" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:resume" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:resume" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:resume" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:resume" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:resume" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:resume" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:resume" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:resume" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:resume" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:resume" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:suspend", + "item": [ + { + "name": "Suspends a running task.", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:suspend" + ], + "variable": [ + { + "key": "database", + "value": "\"Fq\"\" \"\"\"", + "description": "(Required) 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": "\"Fq\"\" \"\"\"", + "description": "(Required) 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": "Suspends a running task. This is equivalent to an ALTER TASK ... SUSPEND." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:suspend" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:suspend" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:suspend" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:suspend" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:suspend" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:suspend" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:suspend" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:suspend" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:suspend" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:suspend" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:suspend" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "List tasks", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?rootOnly=false&like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "rootOnly", + "value": "false", + "description": "Query parameter to filter the command output to return only root resources (resources with no predecessors)." + }, + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database", + "value": "\"Fq\"\" \"\"\"", + "description": "(Required) 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": "\"Fq\"\" \"\"\"", + "description": "(Required) 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 tasks under the database and schema, with show options as query parameters." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?rootOnly=false&like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "rootOnly", + "value": "false", + "description": "Query parameter to filter the command output to return only root resources (resources with no predecessors)." + }, + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"\\\"\\\"\\\"p!p\\\"\\\"-\\\"\\\"\\\"\\\"#\\\"\\\"a\\\"\",\n \"definition\": \"\",\n \"warehouse\": \"c\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"in7_f\": true,\n \"cillumfb\": false\n },\n \"session_parameters\": {\n \"veniam_91\": 98356371\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\n \"task_relations\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"condition\": \"\",\n \"allow_overlapping_execution\": \"\",\n \"error_integration\": \"\",\n \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n },\n {\n \"name\": \"\\\"w\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"definition\": \"\",\n \"warehouse\": \"NgTV\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"Utee1\": 45254644,\n \"cillum__e\": true\n },\n \"session_parameters\": {\n \"consequat_df\": -7845971\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\n \"task_relations\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"condition\": \"\",\n \"allow_overlapping_execution\": \"\",\n \"error_integration\": \"\",\n \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?rootOnly=false&like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "rootOnly", + "value": "false", + "description": "Query parameter to filter the command output to return only root resources (resources with no predecessors)." + }, + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?rootOnly=false&like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "rootOnly", + "value": "false", + "description": "Query parameter to filter the command output to return only root resources (resources with no predecessors)." + }, + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?rootOnly=false&like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "rootOnly", + "value": "false", + "description": "Query parameter to filter the command output to return only root resources (resources with no predecessors)." + }, + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?rootOnly=false&like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "rootOnly", + "value": "false", + "description": "Query parameter to filter the command output to return only root resources (resources with no predecessors)." + }, + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?rootOnly=false&like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "rootOnly", + "value": "false", + "description": "Query parameter to filter the command output to return only root resources (resources with no predecessors)." + }, + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?rootOnly=false&like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "rootOnly", + "value": "false", + "description": "Query parameter to filter the command output to return only root resources (resources with no predecessors)." + }, + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?rootOnly=false&like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "rootOnly", + "value": "false", + "description": "Query parameter to filter the command output to return only root resources (resources with no predecessors)." + }, + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?rootOnly=false&like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "rootOnly", + "value": "false", + "description": "Query parameter to filter the command output to return only root resources (resources with no predecessors)." + }, + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?rootOnly=false&like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "rootOnly", + "value": "false", + "description": "Query parameter to filter the command output to return only root resources (resources with no predecessors)." + }, + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?rootOnly=false&like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "rootOnly", + "value": "false", + "description": "Query parameter to filter the command output to return only root resources (resources with no predecessors)." + }, + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?rootOnly=false&like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "rootOnly", + "value": "false", + "description": "Query parameter to filter the command output to return only root resources (resources with no predecessors)." + }, + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "Create a task", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"l\",\n \"definition\": \"\",\n \"warehouse\": \"bBzuom\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"nostrud2_9\": -65835073\n },\n \"session_parameters\": {\n \"voluptate6a2\": 27785958\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\n \"task_relations\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"condition\": \"\",\n \"allow_overlapping_execution\": \"\",\n \"error_integration\": \"\",\n \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database", + "value": "\"Fq\"\" \"\"\"", + "description": "(Required) 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": "\"Fq\"\" \"\"\"", + "description": "(Required) 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 task, with standard create modifiers as query parameters. See the Task 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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"l\",\n \"definition\": \"\",\n \"warehouse\": \"bBzuom\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"nostrud2_9\": -65835073\n },\n \"session_parameters\": {\n \"voluptate6a2\": 27785958\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\n \"task_relations\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"condition\": \"\",\n \"allow_overlapping_execution\": \"\",\n \"error_integration\": \"\",\n \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"l\",\n \"definition\": \"\",\n \"warehouse\": \"bBzuom\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"nostrud2_9\": -65835073\n },\n \"session_parameters\": {\n \"voluptate6a2\": 27785958\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\n \"task_relations\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"condition\": \"\",\n \"allow_overlapping_execution\": \"\",\n \"error_integration\": \"\",\n \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"l\",\n \"definition\": \"\",\n \"warehouse\": \"bBzuom\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"nostrud2_9\": -65835073\n },\n \"session_parameters\": {\n \"voluptate6a2\": 27785958\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\n \"task_relations\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"condition\": \"\",\n \"allow_overlapping_execution\": \"\",\n \"error_integration\": \"\",\n \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"l\",\n \"definition\": \"\",\n \"warehouse\": \"bBzuom\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"nostrud2_9\": -65835073\n },\n \"session_parameters\": {\n \"voluptate6a2\": 27785958\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\n \"task_relations\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"condition\": \"\",\n \"allow_overlapping_execution\": \"\",\n \"error_integration\": \"\",\n \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"l\",\n \"definition\": \"\",\n \"warehouse\": \"bBzuom\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"nostrud2_9\": -65835073\n },\n \"session_parameters\": {\n \"voluptate6a2\": 27785958\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\n \"task_relations\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"condition\": \"\",\n \"allow_overlapping_execution\": \"\",\n \"error_integration\": \"\",\n \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"l\",\n \"definition\": \"\",\n \"warehouse\": \"bBzuom\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"nostrud2_9\": -65835073\n },\n \"session_parameters\": {\n \"voluptate6a2\": 27785958\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\n \"task_relations\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"condition\": \"\",\n \"allow_overlapping_execution\": \"\",\n \"error_integration\": \"\",\n \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"l\",\n \"definition\": \"\",\n \"warehouse\": \"bBzuom\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"nostrud2_9\": -65835073\n },\n \"session_parameters\": {\n \"voluptate6a2\": 27785958\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\n \"task_relations\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"condition\": \"\",\n \"allow_overlapping_execution\": \"\",\n \"error_integration\": \"\",\n \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"l\",\n \"definition\": \"\",\n \"warehouse\": \"bBzuom\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"nostrud2_9\": -65835073\n },\n \"session_parameters\": {\n \"voluptate6a2\": 27785958\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\n \"task_relations\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"condition\": \"\",\n \"allow_overlapping_execution\": \"\",\n \"error_integration\": \"\",\n \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"l\",\n \"definition\": \"\",\n \"warehouse\": \"bBzuom\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"nostrud2_9\": -65835073\n },\n \"session_parameters\": {\n \"voluptate6a2\": 27785958\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\n \"task_relations\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"condition\": \"\",\n \"allow_overlapping_execution\": \"\",\n \"error_integration\": \"\",\n \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"l\",\n \"definition\": \"\",\n \"warehouse\": \"bBzuom\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"nostrud2_9\": -65835073\n },\n \"session_parameters\": {\n \"voluptate6a2\": 27785958\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\n \"task_relations\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"condition\": \"\",\n \"allow_overlapping_execution\": \"\",\n \"error_integration\": \"\",\n \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"l\",\n \"definition\": \"\",\n \"warehouse\": \"bBzuom\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"nostrud2_9\": -65835073\n },\n \"session_parameters\": {\n \"voluptate6a2\": 27785958\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\n \"task_relations\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"condition\": \"\",\n \"allow_overlapping_execution\": \"\",\n \"error_integration\": \"\",\n \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"l\",\n \"definition\": \"\",\n \"warehouse\": \"bBzuom\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"nostrud2_9\": -65835073\n },\n \"session_parameters\": {\n \"voluptate6a2\": 27785958\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\n \"task_relations\": \"\",\n \"user_task_managed_initial_warehouse_size\": \"\",\n \"user_task_timeout_ms\": \"\",\n \"suspend_task_after_num_failures\": \"\",\n \"condition\": \"\",\n \"allow_overlapping_execution\": \"\",\n \"error_integration\": \"\",\n \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + }, + { + "key": "name", + "value": "\"Fq\"\" \"\"\"" + }, + { + "key": "name", + "value": "\"Fq\"\" \"\"\"" + }, + { + "key": "name", + "value": "\"Fq\"\" \"\"\"" + } + ] +} \ No newline at end of file diff --git a/public-preview/8.30/collection/Snowflake User API.postman_collection.json b/public-preview/8.30/collection/Snowflake User API.postman_collection.json new file mode 100644 index 0000000..5db84e3 --- /dev/null +++ b/public-preview/8.30/collection/Snowflake User API.postman_collection.json @@ -0,0 +1,3230 @@ +{ + "info": { + "_postman_id": "4be32ac0-6a12-490d-b1e8-7128711e5871", + "name": "Snowflake User API", + "description": "The Snowflake User API is a REST API that you can use to access, update, and perform certain action on Users 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": "28868798", + "_collection_link": "https://snowflake.postman.co/workspace/SnowApi-PuPr~785f3044-d2f3-4a33-8fea-8707898185ed/collection/28868798-4be32ac0-6a12-490d-b1e8-7128711e5871?action=share&source=collection_link&creator=28868798" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "users", + "item": [ + { + "name": "{name}", + "item": [ + { + "name": "Fetch information about a user", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name" + ], + "variable": [ + { + "key": "name", + "value": "EBy3F", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Fetch user information using the result of the DESCRIBE command" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"name\": \"\",\n \"password\": \"\",\n \"login_name\": \"\",\n \"display_name\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"must_change_password\": \"\",\n \"disabled\": \"\",\n \"days_to_expiry\": \"\",\n \"mins_to_unlock\": \"\",\n \"default_warehouse\": \"\",\n \"default_namespace\": \"\",\n \"default_role\": \"\",\n \"default_secondary_roles\": \"\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_fp\": \"\",\n \"rsa_public_key_2\": \"\",\n \"rsa_public_key_2_fp\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"created_on\": \"\",\n \"last_successful_login\": \"\",\n \"expires_at\": \"\",\n \"locked_until\": \"\",\n \"has_password\": \"\",\n \"has_rsa_public_key\": \"\",\n \"ext_authn_duo\": \"\",\n \"ext_authn_uid\": \"\",\n \"owner\": \"\",\n \"snowflake_lock\": false,\n \"snowflake_support\": false,\n \"mins_to_bypass_network_policy\": \"\",\n \"password_last_set\": \"\",\n \"custom_landing_page_url\": \"\",\n \"custom_landing_page_url_flush_next_ui_load\": false\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "Delete a user", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name", + "value": "EBy3F", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Delete a user with the given name." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "Create a user", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"password\": \"\",\n \"login_name\": \"\",\n \"display_name\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"must_change_password\": \"\",\n \"disabled\": \"\",\n \"days_to_expiry\": \"\",\n \"mins_to_unlock\": \"\",\n \"default_warehouse\": \"\",\n \"default_namespace\": \"\",\n \"default_role\": \"\",\n \"default_secondary_roles\": \"\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_fp\": \"\",\n \"rsa_public_key_2\": \"\",\n \"rsa_public_key_2_fp\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"created_on\": \"\",\n \"last_successful_login\": \"\",\n \"expires_at\": \"\",\n \"locked_until\": \"\",\n \"has_password\": \"\",\n \"has_rsa_public_key\": \"\",\n \"ext_authn_duo\": \"\",\n \"ext_authn_uid\": \"\",\n \"owner\": \"\",\n \"snowflake_lock\": false,\n \"snowflake_support\": false,\n \"mins_to_bypass_network_policy\": \"\",\n \"password_last_set\": \"\",\n \"custom_landing_page_url\": \"\",\n \"custom_landing_page_url_flush_next_ui_load\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + }, + "description": "Create a user according to the parameters given" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"password\": \"\",\n \"login_name\": \"\",\n \"display_name\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"must_change_password\": \"\",\n \"disabled\": \"\",\n \"days_to_expiry\": \"\",\n \"mins_to_unlock\": \"\",\n \"default_warehouse\": \"\",\n \"default_namespace\": \"\",\n \"default_role\": \"\",\n \"default_secondary_roles\": \"\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_fp\": \"\",\n \"rsa_public_key_2\": \"\",\n \"rsa_public_key_2_fp\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"created_on\": \"\",\n \"last_successful_login\": \"\",\n \"expires_at\": \"\",\n \"locked_until\": \"\",\n \"has_password\": \"\",\n \"has_rsa_public_key\": \"\",\n \"ext_authn_duo\": \"\",\n \"ext_authn_uid\": \"\",\n \"owner\": \"\",\n \"snowflake_lock\": false,\n \"snowflake_support\": false,\n \"mins_to_bypass_network_policy\": \"\",\n \"password_last_set\": \"\",\n \"custom_landing_page_url\": \"\",\n \"custom_landing_page_url_flush_next_ui_load\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"password\": \"\",\n \"login_name\": \"\",\n \"display_name\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"must_change_password\": \"\",\n \"disabled\": \"\",\n \"days_to_expiry\": \"\",\n \"mins_to_unlock\": \"\",\n \"default_warehouse\": \"\",\n \"default_namespace\": \"\",\n \"default_role\": \"\",\n \"default_secondary_roles\": \"\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_fp\": \"\",\n \"rsa_public_key_2\": \"\",\n \"rsa_public_key_2_fp\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"created_on\": \"\",\n \"last_successful_login\": \"\",\n \"expires_at\": \"\",\n \"locked_until\": \"\",\n \"has_password\": \"\",\n \"has_rsa_public_key\": \"\",\n \"ext_authn_duo\": \"\",\n \"ext_authn_uid\": \"\",\n \"owner\": \"\",\n \"snowflake_lock\": false,\n \"snowflake_support\": false,\n \"mins_to_bypass_network_policy\": \"\",\n \"password_last_set\": \"\",\n \"custom_landing_page_url\": \"\",\n \"custom_landing_page_url_flush_next_ui_load\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"password\": \"\",\n \"login_name\": \"\",\n \"display_name\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"must_change_password\": \"\",\n \"disabled\": \"\",\n \"days_to_expiry\": \"\",\n \"mins_to_unlock\": \"\",\n \"default_warehouse\": \"\",\n \"default_namespace\": \"\",\n \"default_role\": \"\",\n \"default_secondary_roles\": \"\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_fp\": \"\",\n \"rsa_public_key_2\": \"\",\n \"rsa_public_key_2_fp\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"created_on\": \"\",\n \"last_successful_login\": \"\",\n \"expires_at\": \"\",\n \"locked_until\": \"\",\n \"has_password\": \"\",\n \"has_rsa_public_key\": \"\",\n \"ext_authn_duo\": \"\",\n \"ext_authn_uid\": \"\",\n \"owner\": \"\",\n \"snowflake_lock\": false,\n \"snowflake_support\": false,\n \"mins_to_bypass_network_policy\": \"\",\n \"password_last_set\": \"\",\n \"custom_landing_page_url\": \"\",\n \"custom_landing_page_url_flush_next_ui_load\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"password\": \"\",\n \"login_name\": \"\",\n \"display_name\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"must_change_password\": \"\",\n \"disabled\": \"\",\n \"days_to_expiry\": \"\",\n \"mins_to_unlock\": \"\",\n \"default_warehouse\": \"\",\n \"default_namespace\": \"\",\n \"default_role\": \"\",\n \"default_secondary_roles\": \"\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_fp\": \"\",\n \"rsa_public_key_2\": \"\",\n \"rsa_public_key_2_fp\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"created_on\": \"\",\n \"last_successful_login\": \"\",\n \"expires_at\": \"\",\n \"locked_until\": \"\",\n \"has_password\": \"\",\n \"has_rsa_public_key\": \"\",\n \"ext_authn_duo\": \"\",\n \"ext_authn_uid\": \"\",\n \"owner\": \"\",\n \"snowflake_lock\": false,\n \"snowflake_support\": false,\n \"mins_to_bypass_network_policy\": \"\",\n \"password_last_set\": \"\",\n \"custom_landing_page_url\": \"\",\n \"custom_landing_page_url_flush_next_ui_load\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"password\": \"\",\n \"login_name\": \"\",\n \"display_name\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"must_change_password\": \"\",\n \"disabled\": \"\",\n \"days_to_expiry\": \"\",\n \"mins_to_unlock\": \"\",\n \"default_warehouse\": \"\",\n \"default_namespace\": \"\",\n \"default_role\": \"\",\n \"default_secondary_roles\": \"\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_fp\": \"\",\n \"rsa_public_key_2\": \"\",\n \"rsa_public_key_2_fp\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"created_on\": \"\",\n \"last_successful_login\": \"\",\n \"expires_at\": \"\",\n \"locked_until\": \"\",\n \"has_password\": \"\",\n \"has_rsa_public_key\": \"\",\n \"ext_authn_duo\": \"\",\n \"ext_authn_uid\": \"\",\n \"owner\": \"\",\n \"snowflake_lock\": false,\n \"snowflake_support\": false,\n \"mins_to_bypass_network_policy\": \"\",\n \"password_last_set\": \"\",\n \"custom_landing_page_url\": \"\",\n \"custom_landing_page_url_flush_next_ui_load\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"password\": \"\",\n \"login_name\": \"\",\n \"display_name\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"must_change_password\": \"\",\n \"disabled\": \"\",\n \"days_to_expiry\": \"\",\n \"mins_to_unlock\": \"\",\n \"default_warehouse\": \"\",\n \"default_namespace\": \"\",\n \"default_role\": \"\",\n \"default_secondary_roles\": \"\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_fp\": \"\",\n \"rsa_public_key_2\": \"\",\n \"rsa_public_key_2_fp\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"created_on\": \"\",\n \"last_successful_login\": \"\",\n \"expires_at\": \"\",\n \"locked_until\": \"\",\n \"has_password\": \"\",\n \"has_rsa_public_key\": \"\",\n \"ext_authn_duo\": \"\",\n \"ext_authn_uid\": \"\",\n \"owner\": \"\",\n \"snowflake_lock\": false,\n \"snowflake_support\": false,\n \"mins_to_bypass_network_policy\": \"\",\n \"password_last_set\": \"\",\n \"custom_landing_page_url\": \"\",\n \"custom_landing_page_url_flush_next_ui_load\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"password\": \"\",\n \"login_name\": \"\",\n \"display_name\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"must_change_password\": \"\",\n \"disabled\": \"\",\n \"days_to_expiry\": \"\",\n \"mins_to_unlock\": \"\",\n \"default_warehouse\": \"\",\n \"default_namespace\": \"\",\n \"default_role\": \"\",\n \"default_secondary_roles\": \"\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_fp\": \"\",\n \"rsa_public_key_2\": \"\",\n \"rsa_public_key_2_fp\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"created_on\": \"\",\n \"last_successful_login\": \"\",\n \"expires_at\": \"\",\n \"locked_until\": \"\",\n \"has_password\": \"\",\n \"has_rsa_public_key\": \"\",\n \"ext_authn_duo\": \"\",\n \"ext_authn_uid\": \"\",\n \"owner\": \"\",\n \"snowflake_lock\": false,\n \"snowflake_support\": false,\n \"mins_to_bypass_network_policy\": \"\",\n \"password_last_set\": \"\",\n \"custom_landing_page_url\": \"\",\n \"custom_landing_page_url_flush_next_ui_load\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"password\": \"\",\n \"login_name\": \"\",\n \"display_name\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"must_change_password\": \"\",\n \"disabled\": \"\",\n \"days_to_expiry\": \"\",\n \"mins_to_unlock\": \"\",\n \"default_warehouse\": \"\",\n \"default_namespace\": \"\",\n \"default_role\": \"\",\n \"default_secondary_roles\": \"\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_fp\": \"\",\n \"rsa_public_key_2\": \"\",\n \"rsa_public_key_2_fp\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"created_on\": \"\",\n \"last_successful_login\": \"\",\n \"expires_at\": \"\",\n \"locked_until\": \"\",\n \"has_password\": \"\",\n \"has_rsa_public_key\": \"\",\n \"ext_authn_duo\": \"\",\n \"ext_authn_uid\": \"\",\n \"owner\": \"\",\n \"snowflake_lock\": false,\n \"snowflake_support\": false,\n \"mins_to_bypass_network_policy\": \"\",\n \"password_last_set\": \"\",\n \"custom_landing_page_url\": \"\",\n \"custom_landing_page_url_flush_next_ui_load\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"password\": \"\",\n \"login_name\": \"\",\n \"display_name\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"must_change_password\": \"\",\n \"disabled\": \"\",\n \"days_to_expiry\": \"\",\n \"mins_to_unlock\": \"\",\n \"default_warehouse\": \"\",\n \"default_namespace\": \"\",\n \"default_role\": \"\",\n \"default_secondary_roles\": \"\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_fp\": \"\",\n \"rsa_public_key_2\": \"\",\n \"rsa_public_key_2_fp\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"created_on\": \"\",\n \"last_successful_login\": \"\",\n \"expires_at\": \"\",\n \"locked_until\": \"\",\n \"has_password\": \"\",\n \"has_rsa_public_key\": \"\",\n \"ext_authn_duo\": \"\",\n \"ext_authn_uid\": \"\",\n \"owner\": \"\",\n \"snowflake_lock\": false,\n \"snowflake_support\": false,\n \"mins_to_bypass_network_policy\": \"\",\n \"password_last_set\": \"\",\n \"custom_landing_page_url\": \"\",\n \"custom_landing_page_url_flush_next_ui_load\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"password\": \"\",\n \"login_name\": \"\",\n \"display_name\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"must_change_password\": \"\",\n \"disabled\": \"\",\n \"days_to_expiry\": \"\",\n \"mins_to_unlock\": \"\",\n \"default_warehouse\": \"\",\n \"default_namespace\": \"\",\n \"default_role\": \"\",\n \"default_secondary_roles\": \"\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_fp\": \"\",\n \"rsa_public_key_2\": \"\",\n \"rsa_public_key_2_fp\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"created_on\": \"\",\n \"last_successful_login\": \"\",\n \"expires_at\": \"\",\n \"locked_until\": \"\",\n \"has_password\": \"\",\n \"has_rsa_public_key\": \"\",\n \"ext_authn_duo\": \"\",\n \"ext_authn_uid\": \"\",\n \"owner\": \"\",\n \"snowflake_lock\": false,\n \"snowflake_support\": false,\n \"mins_to_bypass_network_policy\": \"\",\n \"password_last_set\": \"\",\n \"custom_landing_page_url\": \"\",\n \"custom_landing_page_url_flush_next_ui_load\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"password\": \"\",\n \"login_name\": \"\",\n \"display_name\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"must_change_password\": \"\",\n \"disabled\": \"\",\n \"days_to_expiry\": \"\",\n \"mins_to_unlock\": \"\",\n \"default_warehouse\": \"\",\n \"default_namespace\": \"\",\n \"default_role\": \"\",\n \"default_secondary_roles\": \"\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_fp\": \"\",\n \"rsa_public_key_2\": \"\",\n \"rsa_public_key_2_fp\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"created_on\": \"\",\n \"last_successful_login\": \"\",\n \"expires_at\": \"\",\n \"locked_until\": \"\",\n \"has_password\": \"\",\n \"has_rsa_public_key\": \"\",\n \"ext_authn_duo\": \"\",\n \"ext_authn_uid\": \"\",\n \"owner\": \"\",\n \"snowflake_lock\": false,\n \"snowflake_support\": false,\n \"mins_to_bypass_network_policy\": \"\",\n \"password_last_set\": \"\",\n \"custom_landing_page_url\": \"\",\n \"custom_landing_page_url_flush_next_ui_load\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"password\": \"\",\n \"login_name\": \"\",\n \"display_name\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"must_change_password\": \"\",\n \"disabled\": \"\",\n \"days_to_expiry\": \"\",\n \"mins_to_unlock\": \"\",\n \"default_warehouse\": \"\",\n \"default_namespace\": \"\",\n \"default_role\": \"\",\n \"default_secondary_roles\": \"\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_fp\": \"\",\n \"rsa_public_key_2\": \"\",\n \"rsa_public_key_2_fp\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"created_on\": \"\",\n \"last_successful_login\": \"\",\n \"expires_at\": \"\",\n \"locked_until\": \"\",\n \"has_password\": \"\",\n \"has_rsa_public_key\": \"\",\n \"ext_authn_duo\": \"\",\n \"ext_authn_uid\": \"\",\n \"owner\": \"\",\n \"snowflake_lock\": false,\n \"snowflake_support\": false,\n \"mins_to_bypass_network_policy\": \"\",\n \"password_last_set\": \"\",\n \"custom_landing_page_url\": \"\",\n \"custom_landing_page_url_flush_next_ui_load\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"password\": \"\",\n \"login_name\": \"\",\n \"display_name\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"must_change_password\": \"\",\n \"disabled\": \"\",\n \"days_to_expiry\": \"\",\n \"mins_to_unlock\": \"\",\n \"default_warehouse\": \"\",\n \"default_namespace\": \"\",\n \"default_role\": \"\",\n \"default_secondary_roles\": \"\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_fp\": \"\",\n \"rsa_public_key_2\": \"\",\n \"rsa_public_key_2_fp\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"created_on\": \"\",\n \"last_successful_login\": \"\",\n \"expires_at\": \"\",\n \"locked_until\": \"\",\n \"has_password\": \"\",\n \"has_rsa_public_key\": \"\",\n \"ext_authn_duo\": \"\",\n \"ext_authn_uid\": \"\",\n \"owner\": \"\",\n \"snowflake_lock\": false,\n \"snowflake_support\": false,\n \"mins_to_bypass_network_policy\": \"\",\n \"password_last_set\": \"\",\n \"custom_landing_page_url\": \"\",\n \"custom_landing_page_url_flush_next_ui_load\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "List users in the system.", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ] + }, + "description": "Lists the users in the system." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"\",\n \"password\": \"\",\n \"login_name\": \"\",\n \"display_name\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"must_change_password\": \"\",\n \"disabled\": \"\",\n \"days_to_expiry\": \"\",\n \"mins_to_unlock\": \"\",\n \"default_warehouse\": \"\",\n \"default_namespace\": \"\",\n \"default_role\": \"\",\n \"default_secondary_roles\": \"\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_fp\": \"\",\n \"rsa_public_key_2\": \"\",\n \"rsa_public_key_2_fp\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"created_on\": \"\",\n \"last_successful_login\": \"\",\n \"expires_at\": \"\",\n \"locked_until\": \"\",\n \"has_password\": \"\",\n \"has_rsa_public_key\": \"\",\n \"ext_authn_duo\": \"\",\n \"ext_authn_uid\": \"\",\n \"owner\": \"\",\n \"snowflake_lock\": false,\n \"snowflake_support\": false,\n \"mins_to_bypass_network_policy\": \"\",\n \"password_last_set\": \"\",\n \"custom_landing_page_url\": \"\",\n \"custom_landing_page_url_flush_next_ui_load\": false\n },\n {\n \"name\": \"\",\n \"password\": \"\",\n \"login_name\": \"\",\n \"display_name\": \"\",\n \"first_name\": \"\",\n \"middle_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"must_change_password\": \"\",\n \"disabled\": \"\",\n \"days_to_expiry\": \"\",\n \"mins_to_unlock\": \"\",\n \"default_warehouse\": \"\",\n \"default_namespace\": \"\",\n \"default_role\": \"\",\n \"default_secondary_roles\": \"\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_fp\": \"\",\n \"rsa_public_key_2\": \"\",\n \"rsa_public_key_2_fp\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"created_on\": \"\",\n \"last_successful_login\": \"\",\n \"expires_at\": \"\",\n \"locked_until\": \"\",\n \"has_password\": \"\",\n \"has_rsa_public_key\": \"\",\n \"ext_authn_duo\": \"\",\n \"ext_authn_uid\": \"\",\n \"owner\": \"\",\n \"snowflake_lock\": false,\n \"snowflake_support\": false,\n \"mins_to_bypass_network_policy\": \"\",\n \"password_last_set\": \"\",\n \"custom_landing_page_url\": \"\",\n \"custom_landing_page_url_flush_next_ui_load\": false\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + }, + { + "key": "startsWith", + "value": "", + "description": "Query 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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "fromName", + "value": "", + "description": "Query 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." + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + } + ] + } + ] + } + ], + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + } + ] +} \ No newline at end of file diff --git a/public-preview/8.30/collection/Snowflake Warehouse API.postman_collection.json b/public-preview/8.30/collection/Snowflake Warehouse API.postman_collection.json new file mode 100644 index 0000000..3d5dd72 --- /dev/null +++ b/public-preview/8.30/collection/Snowflake Warehouse API.postman_collection.json @@ -0,0 +1,7422 @@ +{ + "info": { + "_postman_id": "087537ff-6799-4a06-9cb7-dc7233fb9c54", + "name": "Snowflake Warehouse API", + "description": "The Snowflake Warehouse API is a REST API that you can use to access, customize and manage virtual warehouse in a Snowflake account.\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": "28868798", + "_collection_link": "https://snowflake.postman.co/workspace/SnowApi-PuPr~785f3044-d2f3-4a33-8fea-8707898185ed/collection/28868798-087537ff-6799-4a06-9cb7-dc7233fb9c54?action=share&source=collection_link&creator=28868798" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "warehouses", + "item": [ + { + "name": "{name}", + "item": [ + { + "name": "Describe warehouse", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "variable": [ + { + "key": "name", + "value": "IDlSMO", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Describes the warehouse, show information of the chosen warehouse. Equivalent to DESCRIBE WAREHOUSE in SQL." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "Drop warehouse", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name", + "value": "IDlSMO", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Removes the specified virtual warehouse from the system. Equivalent to DROP WAREHOUSE in SQL." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "Create a (or alter an existing) warehouse.", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "variable": [ + { + "key": "name", + "value": "IDlSMO", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Create a (or alter an existing) warehouse. 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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:resume", + "item": [ + { + "name": "resume warehouse", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + }, + "description": "Bring current warehouse to a usable ‘Running’ state by provisioning compute resources if current warehouse is suspended." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:resume?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:resume" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:suspend", + "item": [ + { + "name": "suspend warehouse", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + }, + "description": "Remove all compute nodes from a warehouse and put the warehouse into a ‘Suspended’ state if current warehouse is not suspended." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:suspend?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:suspend" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:rename", + "item": [ + { + "name": "update and rename warehouse", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:rename?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:rename" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + }, + "description": "Specifies a new identifier for the warehouse; must be unique for current account." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:rename?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:rename" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:rename?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:rename" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:rename?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:rename" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:rename?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:rename" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:rename?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:rename" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:rename?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:rename" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:rename?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:rename" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:rename?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:rename" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:rename?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:rename" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:rename?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:rename" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:rename?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:rename" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:rename?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:rename" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:rename?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:rename" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:abort", + "item": [ + { + "name": "abort all queries", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:abort?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:abort" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + }, + "description": "Aborts all the queries currently running or queued on the warehouse." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:abort?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:abort" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:abort?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:abort" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:abort?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:abort" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:abort?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:abort" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:abort?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:abort" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:abort?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:abort" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:abort?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:abort" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:abort?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:abort" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:abort?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:abort" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:abort?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:abort" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:abort?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:abort" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:abort?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:abort" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:abort?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:abort" + ], + "query": [ + { + "key": "ifExists", + "value": "false", + "description": "Query 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." + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:use", + "item": [ + { + "name": "use current warehouse for session", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:use", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:use" + ] + }, + "description": "[Deprecated] Specifies the active/current warehouse for the session." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:use", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:use" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:use", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:use" + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:use", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:use" + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:use", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:use" + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:use", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:use" + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:use", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:use" + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:use", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:use" + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:use", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:use" + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:use", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:use" + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:use", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:use" + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:use", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:use" + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:use", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:use" + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:use", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:use" + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "Create or replace warehouse", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + }, + "description": "Create a virtual warehouse. Equivalent to CREATE WAREHOUSE in SQL." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"jJ\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"\\\"=g`J3\\\"\\\"n9]\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource." + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "List warehouse", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ] + }, + "description": "Show a list of warehouse filtered by pattern. Equivalent to SHOW WAREHOUSE in SQL." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"Bwv21D0ta7\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"true\",\n \"resource_monitor\": \"\\\"?\\\"\\\"\\\"\\\"D\\\"\\\"\\\"\\\"\\\"\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"false\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n },\n {\n \"name\": \"\\\".&b\\\"\\\"N\\\"\\\"!O5\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"false\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"false\",\n \"initially_suspended\": \"true\",\n \"resource_monitor\": \"yKy_1bteSS\",\n \"comment\": \"\",\n \"enable_query_acceleration\": \"true\",\n \"query_acceleration_max_scale_factor\": \"\",\n \"max_concurrency_level\": \"\",\n \"statement_queued_timeout_in_seconds\": \"\",\n \"statement_timeout_in_seconds\": \"\",\n \"type\": \"\",\n \"size\": \"\",\n \"state\": \"\",\n \"started_clusters\": \"\",\n \"running\": \"\",\n \"queued\": \"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"available\": \"\",\n \"provisioning\": \"\",\n \"quiescing\": \"\",\n \"other\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\",\n \"budget\": \"\",\n \"kind\": \"\",\n \"owner_role_type\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Location", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"code\": \"\",\n \"message\": \"\",\n \"resultHandler\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gone. This error is primarily intended to assist the task of web maintenance by notifying the recipient that the resource is intentionally unavailable.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\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" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses" + ], + "query": [ + { + "key": "like", + "value": "", + "description": "Query parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters." + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Snowflake-Request-ID", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"code\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + } + ] + } + ] + } + ], + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + }, + { + "key": "name", + "value": "IDlSMO" + }, + { + "key": "name", + "value": "IDlSMO" + }, + { + "key": "name", + "value": "IDlSMO" + }, + { + "key": "name", + "value": "IDlSMO" + }, + { + "key": "name", + "value": "IDlSMO" + } + ] +} \ No newline at end of file diff --git a/public-preview/8.30/specification/common.yaml b/public-preview/8.30/specification/common.yaml new file mode 100644 index 0000000..7808d84 --- /dev/null +++ b/public-preview/8.30/specification/common.yaml @@ -0,0 +1,530 @@ +components: + schemas: + description: If the identifier contains spaces or special characters, the entire + string must be enclosed in double quotes. Identifiers enclosed in double quotes + are also case-sensitive. + Identifier: + type: string + description: A Snowflake object identifier. + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + example: TEST_NAME + ErrorResponse: + type: object + properties: + message: + type: string + description: Error message returned by the server + code: + type: string + description: Error code. + error_code: + type: string + description: Error code, same as `code` above. This property has been deprecated + and will be removed in a future release, but is temporarily supported + for for short-term backward compatibility. + request_id: + type: string + description: Unique request ID. + example: + message: Compilation error! + error_code: '390189' + request_id: 01afef9d-0607-0550-0001-dd270c3902d7 + SuccessResponse: + type: object + description: Schema for all the success responses returned by the server. + properties: + status: + type: string + description: Message returned by the server. + example: + status: Request successfully completed + SuccessAcceptedResponse: + type: object + description: Schema for a request in progress response returned by the server. + properties: + code: + type: string + description: Message code returned by the server. + message: + type: string + description: Message returned by the server + resultHandler: + type: string + description: Opaque result ID used for checking for request completion through + one or more subsequent completion check operations. + example: + code: '392604' + message: Request execution in progress. Use the provided location header or + result handler ID to perform query monitoring and management. + PointOfTime: + type: object + description: Point of time. + required: + - point_of_time_type + properties: + point_of_time_type: + description: 'Type of the point of time. Possible values include: + + - `timestamp`: Exact time using the standard timezone format. Example: + `2023-09-15 10:59:43`. - `offset`: Interval relative to ''now.'' Example: + `1 day`. - `statement`: ID of a query statement to use as the reference + point for Time + Travel. + + For more information, see https://docs.snowflake.com/en/sql-reference/data-types-datetime.' + type: string + examples: + timestamp: + value: '2023-09-15 10:59:43' + offset: + value: 20 ms + reference: + type: string + description: Relation to the point of time. Currently, the API supports + `at` and `before`. + discriminator: + propertyName: point_of_time_type + mapping: + timestamp: PointOfTimeTimestamp + offset: PointOfTimeOffset + statement: PointOfTimeStatement + PointOfTimeTimestamp: + description: Point of time identified by a timestamp. + allOf: + - $ref: '#/components/schemas/PointOfTime' + properties: + timestamp: + type: string + description: Timestamp of the point of time. + PointOfTimeOffset: + description: Point of time identified by an offset in reference to the current + time, such as `10 min`. + allOf: + - $ref: '#/components/schemas/PointOfTime' + examples: + month: + value: 2 months + milliseconds: + value: 20 ms + properties: + offset: + type: string + description: 'Offset from the point of time. Example: `1 year`' + PointOfTimeStatement: + description: Point of time indicating when a statement was executed. + allOf: + - $ref: '#/components/schemas/PointOfTime' + properties: + statement: + type: string + description: Statement of the point of time. + Parameter: + description: Snowflake parameter defined at the system, account, user, session, + or object level. + type: object + required: + - name + properties: + name: + type: string + description: Parameter name. + value: + type: string + description: Parameter value. + defaultValue: + type: string + description: Default parameter value. + dataType: + type: string + description: Data type of the parameter value. Either BOOLEAN, NUMBER, FLOAT, + or STRING. + level: + type: string + description: Level at which parameter is defined. + description: + type: string + description: Parameter description. + example: + name: SAMPLE_SNOWAPI_PARAM + value: true + defaultValue: false + dataType: boolean + level: ACCOUNT + description: Sample snowflake parameter. + parameters: + database: + name: database + 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. + required: true + in: path + schema: + example: TEST_DB + $ref: ./common.yaml#/components/schemas/Identifier + schema: + name: schema + 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. + required: true + in: path + schema: + example: TEST_SCHEMA + $ref: ./common.yaml#/components/schemas/Identifier + name: + name: name + description: Identifier (i.e. name) for the resource. + required: true + in: path + schema: + example: TEST_NAME + $ref: ./common.yaml#/components/schemas/Identifier + nameWithArgs: + name: nameWithArgs + description: Function's name with Args + required: true + in: path + schema: + type: string + example: foo(a number, b number) + createMode: + name: createMode + 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. + + - `orReplace`: Automatically replaces the existing resource with the current + one. + + - `ifNotExists`: Creates a new resource when an alter is requested for a non-existent + resource.' + in: query + schema: + type: string + enum: + - errorIfExists + - orReplace + - ifNotExists + example: ifNotExists + default: errorIfExists + ifExists: + name: ifExists + description: 'Query parameter that specifies how to handle the request for a + resource that does not exist: + + - `true`: The endpoint does not throw an error if the resource does not exist. + It returns a 200 success response, but does not take any action on the resource. + + - `false`: The endpoint throws an error if the resource doesn''t exist.' + in: query + schema: + type: boolean + example: true + default: false + like: + name: like + description: Query parameter to filter the command output by resource name. + Uses case-insensitive pattern matching, with support for SQL wildcard characters. + in: query + schema: + type: string + example: test_% + pattern: + name: pattern + description: A query parameter that filters the command output by a regular + expression pattern. + in: query + schema: + type: string + example: .*data_0.* + startsWith: + name: startsWith + description: Query 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. + in: query + schema: + type: string + example: test + rootOnly: + name: rootOnly + description: Query parameter to filter the command output to return only root + resources (resources with no predecessors). + in: query + schema: + type: boolean + example: false + default: false + showLimit: + name: showLimit + description: Query parameter to limit the maximum number of rows returned by + a command. + in: query + schema: + type: integer + example: 10 + minimum: 1 + maximum: 10000 + fromName: + name: fromName + description: Query 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. + in: query + schema: + type: string + example: from_test + copyGrants: + name: copyGrants + description: Query parameter to enable copy grants when creating the object. + in: query + schema: + type: boolean + example: false + default: false + sessionId: + name: sessionId + description: Unique ID for the current session. + required: true + in: path + schema: + type: integer + format: uuid + example: 524514326772799 + content-type: + name: Content-Type + description: Type of content for the resource. Currently supports `application/json`. + in: header + schema: + type: string + enum: + - application/json + accept: + name: Accept + description: Type of data format accepted by the resource. Currently supports + `application/json`. + in: header + schema: + type: string + enum: + - application/json + x-snowflake-authorization-token-type: + name: X-Snowflake-Authorization-Token-Type + description: Type of the Snowflake authorization token. Currently, keypair-jwt + (`KEYPAIR_JWT`) and OAuth tokens are supported. + in: header + schema: + type: string + enum: + - KEYPAIR_JWT + - OAUTH + x-sfc-session: + name: X-Sfc-Session + description: Token for the current Snowflake session. + in: header + required: false + schema: + type: string + description: Snowflake session token. + example: ver:3-hint:1000-ABCD= + headers: + X-Snowflake-Request-ID: + description: Unique ID of the API request. + schema: + type: string + format: uuid + securitySchemes: + keyPair: + type: http + scheme: bearer + bearerFormat: JWT + description: Set `X-Snowflake-Authorization-Token-Type` to `KEYPAIR_JWT` if + the token is a key-pair authentication JWT. + ExternalOAuth: + type: http + scheme: bearer + bearerFormat: JWT + description: Configure External Oauth with Snowflake (see External + OAuth overview.) Set `X-Snowflake-Authorization-Token-Type` to `OAUTH` + and set the Token to the auth token received from the external Auth server. + SnowflakeOAuth: + type: oauth2 + flows: + implicit: + authorizationUrl: /oauth/authorize + scopes: {} + description: Set `X-Snowflake-Authorization-Token-Type` to `OAUTH` if the token + is snowflakeOAuth + responses: + 200SuccessResponse: + description: Successful request. + headers: + X-Snowflake-Request-ID: + $ref: '#/components/headers/X-Snowflake-Request-ID' + content: + application/json: + schema: + $ref: '#/components/schemas/SuccessResponse' + 201SuccessCreatedResponse: + description: Successfully created a new resource on the server. + headers: + X-Snowflake-Request-ID: + $ref: '#/components/headers/X-Snowflake-Request-ID' + content: + application/json: + schema: + $ref: '#/components/schemas/SuccessResponse' + 202SuccessAcceptedResponse: + headers: + Location: + schema: + type: string + description: Relative path for checking request status or getting the + result, if available. + X-Snowflake-Request-ID: + $ref: '#/components/headers/X-Snowflake-Request-ID' + description: Successfully accepted the request, but it is not completed yet. + content: + application/json: + schema: + $ref: '#/components/schemas/SuccessAcceptedResponse' + 400BadRequest: + description: Bad Request. The request payload is invalid or malformed. This + happens if the application didn't send the correct request payload. The response + body may include the error code and message indicating the actual cause. The + application must reconstruct the request body for retry. + headers: + X-Snowflake-Request-ID: + $ref: '#/components/headers/X-Snowflake-Request-ID' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + 401Unauthorized: + description: Unauthorized. The request is not authorized. This happens if the + attached access token is invalid or missing. The response body may include + the error code and message indicating the actual cause, e.g., expired, invalid + token. The application must obtain a new access token for retry. + headers: + X-Snowflake-Request-ID: + $ref: '#/components/headers/X-Snowflake-Request-ID' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + 403Forbidden: + description: Forbidden. The request is forbidden. This can also happen if the + request is made even if the API is not enabled. + headers: + X-Snowflake-Request-ID: + $ref: '#/components/headers/X-Snowflake-Request-ID' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + 404NotFound: + description: Not Found. The request endpoint is not valid. This happens if the + API endpoint does not exist, or if the API is not enabled. + headers: + X-Snowflake-Request-ID: + $ref: '#/components/headers/X-Snowflake-Request-ID' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + 405MethodNotAllowed: + description: 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. + headers: + X-Snowflake-Request-ID: + $ref: '#/components/headers/X-Snowflake-Request-ID' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + 409Conflict: + description: Conflict. The requested operation could not be performed due to + a conflicting state that could not be resolved. This usually happens when + a CREATE request was performed when there is a pre-existing resource with + the same name, and also without one of the options orReplace/ifNotExists. + headers: + X-Snowflake-Request-ID: + $ref: '#/components/headers/X-Snowflake-Request-ID' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + 410Gone: + description: Gone. This error is primarily intended to assist the task of web + maintenance by notifying the recipient that the resource is intentionally + unavailable. + headers: + X-Snowflake-Request-ID: + $ref: '#/components/headers/X-Snowflake-Request-ID' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + 415UnsupportedMediaType: + description: The request header Content-Type includes an unsupported media type. + The API supports application/json only. If none specified, the request payload + is taken as JSON, but if any other media type is specified, this error is + returned. + headers: + X-Snowflake-Request-ID: + $ref: '#/components/headers/X-Snowflake-Request-ID' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + 429LimitExceeded: + description: Limit Exceeded. The number of requests hit the rate limit. The + application must slow down the frequency of hitting the API endpoints. + headers: + X-Snowflake-Request-ID: + $ref: '#/components/headers/X-Snowflake-Request-ID' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + 500InternalServerError: + description: 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. + headers: + X-Snowflake-Request-ID: + $ref: '#/components/headers/X-Snowflake-Request-ID' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + 503ServiceUnavailable: + description: Service Unavailable. The request was not processed due to server + side timeouts. The application may retry with backoff. The jittered backoff + is recommended. + headers: + X-Snowflake-Request-ID: + $ref: '#/components/headers/X-Snowflake-Request-ID' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + 504GatewayTimeout: + description: Gateway Timeout. The request was not processed due to server side + timeouts. The application may retry with backoff. The jittered backoff is + recommended. + headers: + X-Snowflake-Request-ID: + $ref: '#/components/headers/X-Snowflake-Request-ID' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + security: + - keyPair: [] + - ExternalOAuth: [] + - SnowflakeOAuth: [] diff --git a/public-preview/8.30/specification/compute-pool.yaml b/public-preview/8.30/specification/compute-pool.yaml new file mode 100644 index 0000000..692df3e --- /dev/null +++ b/public-preview/8.30/specification/compute-pool.yaml @@ -0,0 +1,422 @@ +openapi: 3.0.0 +servers: +- description: Snowflake Compute Pools API + url: https://org-account.snowflakecomputing.com +info: + version: 0.0.1 + title: Snowflake Compute Pools API + description: The Snowflake Compute Pools API is a REST API that you can use to access, + update, and perform common actions on Compute Pool resources. + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/compute-pools: + get: + summary: Lists compute pools. + tags: + - compute-pool + description: Lists the compute pools under the account. + operationId: listComputePools + parameters: + - $ref: common.yaml#/components/parameters/like + - $ref: common.yaml#/components/parameters/startsWith + - $ref: common.yaml#/components/parameters/showLimit + responses: + '200': + description: Successful request. + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ComputePool' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + post: + summary: Creates a compute pool. + tags: + - compute-pool + description: Creates a compute pool, with standard create modifiers as query + parameters. See the Compute Pool component definition for what is required + to be provided in the request body. + operationId: createComputePool + parameters: + - $ref: common.yaml#/components/parameters/createMode + - name: initiallySuspended + in: query + description: Specifies whether the compute pool is created initially in the + suspended state. + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ComputePool' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/compute-pools/{name}: + get: + summary: Fetches a compute pool. + tags: + - compute-pool + description: Fetches a named compute pool. You can get the name of the compute + pool from the `/api/v2/compute-pools` GET request. + operationId: fetchComputePool + parameters: + - $ref: common.yaml#/components/parameters/name + responses: + '200': + description: Successful request. + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + $ref: '#/components/schemas/ComputePool' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + delete: + parameters: + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/ifExists + summary: Deletes a compute pool. + tags: + - compute-pool + description: Deletes a compute pool with the given name. If you enable the `ifExists` + parameter, the operation succeeds even if the object does not exist. Otherwise, + a 404 failure is returned if the object does not exist. + operationId: deleteComputePool + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/compute-pools/{name}:resume: + post: + summary: Resumes a suspended compute pool. + tags: + - compute-pool + description: Resume a compute pool, if suspended. If the specified compute pool + is already running, no action is taken. + operationId: resumeComputePool + parameters: + - $ref: common.yaml#/components/parameters/name + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/compute-pools/{name}:suspend: + post: + summary: Suspends an active compute pool. + tags: + - compute-pool + description: Suspend a compute pool, if active. If the specified compute pool + is already suspended, no action is taken. + operationId: suspendComputePool + parameters: + - $ref: common.yaml#/components/parameters/name + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/compute-pools/{name}:stopallservices: + post: + deprecated: true + summary: Stops all services on the compute pool. + tags: + - compute-pool + description: Stops all services in the compute pool. Deprecated - use :stop-all-services + instead. + operationId: stopAllServicesInComputePoolDeprecated + parameters: + - $ref: common.yaml#/components/parameters/name + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/compute-pools/{name}:stop-all-services: + post: + summary: Stops all services on the compute pool. + tags: + - compute-pool + description: Stops all services in the compute pool. + operationId: stopAllServicesInComputePool + parameters: + - $ref: common.yaml#/components/parameters/name + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +components: + schemas: + ComputePool: + type: object + description: A Snowflake compute pool definition. + properties: + name: + $ref: ./common.yaml#/components/schemas/Identifier + min_nodes: + type: integer + description: Minimum number of nodes for the compute pool. + max_nodes: + type: integer + description: Maximum number of nodes for the compute pool. + instance_family: + type: string + description: Instance family for the compute pool. + auto_resume: + type: boolean + description: Whether Snowflake automatically resumes the compute pool when + any statement that requires the compute pool is submitted. + comment: + type: string + description: Comment describing the compute pool. + state: + type: string + description: Current state of the compute pool. Possible values include + UNKNOWN, STARTING, IDLE, ACTIVE, STOPPING, SUSPENDED, and RESIZING. + readOnly: true + enum: + - UNKNOWN + - STARTING + - IDLE + - ACTIVE + - STOPPING + - SUSPENDED + - RESIZING + num_services: + type: integer + description: Number of services on the compute pool. + readOnly: true + auto_suspend_secs: + type: integer + description: Number of seconds until the compute pool automatically suspends. + format: int64 + active_nodes: + type: integer + description: Number of currently active nodes on the compute pool. + readOnly: true + idle_nodes: + type: integer + description: Number of currently idle nodes on the compute pool. + readOnly: true + target_nodes: + type: integer + description: Number of target nodes on the compute pool. + readOnly: true + created_on: + type: string + description: Time the compute pool was created. + format: date-time + readOnly: true + resumed_on: + type: string + description: Time the compute pool was last resumed. + format: date-time + readOnly: true + updated_on: + type: string + description: Time the compute pool was last updated. + format: date-time + readOnly: true + owner: + type: string + description: Identifier for the current owner of the compute pool. + readOnly: true + error_code: + type: string + description: Current error the compute pool hit if any. + readOnly: true + status_message: + type: string + description: Current status of the compute pool if any. + readOnly: true + example: + name: compute_pool_name + warehouse: test_wh + min_nodes: 4 + max_nodes: 5 + instance_family: compute_pool_family + auto_resume: false + comment: test_comment + state: STARTING + num_services: 1 + auto_suspend_secs: 10 + active_nodes: 2 + idle_nodes: 2 + target_nodes: 4 + created_on: '2024-06-18T01:01:01.111111' + updated_on: '2024-06-18T01:01:01.111111' + resumed_on: '2024-06-18T01:01:01.111111' + owner: POOL_ADMIN + error_code: '392507' + status_message: Compute Pool is resizing for last 10 minutes. We have observed + CAPACITY_ERROR. Please refer to our documentation. + required: + - name + - instance_family + - min_nodes + - max_nodes +tags: +- name: compute-pool diff --git a/public-preview/8.30/specification/cortex-analyst.yaml b/public-preview/8.30/specification/cortex-analyst.yaml new file mode 100644 index 0000000..aa0b05f --- /dev/null +++ b/public-preview/8.30/specification/cortex-analyst.yaml @@ -0,0 +1,256 @@ +openapi: 3.0.0 +servers: +- description: Snowflake API + url: https://org-account.snowflakecomputing.com +info: + version: 0.0.1 + title: Cortex Analyst API + description: The Snowflake Cortex Analyst API is a REST API that allows end user + to chat with their data leveraging semantic models to generate SQL queries. + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/cortex/analyst/message: + post: + operationId: sendMessage + tags: + - cortex-analyst + summary: Send a data question to the Cortex Analyst + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SendMessageRequest' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/SendMessageResponse' + text/event-stream: + schema: + type: string + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +components: + schemas: + StatusUpdate: + type: object + properties: + status: + description: The latest status for processing the request + type: string + status_message: + description: A human readable description on the current request processing + status + type: string + required: + - status + MessageContentDelta: + type: object + properties: + type: + type: string + index: + type: integer + description: The index of the content array this delta object represents + discriminator: + propertyName: type + mapping: + text: '#/components/schemas/MessageContentDeltaTextObject' + sql: '#/components/schemas/MessageContentDeltaSqlObject' + suggestions: '#/components/schemas/MessageContentDeltaSuggestionsObject' + MessageContentDeltaTextObject: + allOf: + - $ref: '#/components/schemas/MessageContentDelta' + - title: Text + type: object + description: The text content that is part of a message. + properties: + text_delta: + type: string + description: The delta of the text content, clients should concatenate + all deltas for the same index + example: To answer the question "What is the profit per store?" we must + aggregate sales at the store level + required: + - text_delta + MessageContentDeltaSqlObject: + allOf: + - $ref: '#/components/schemas/MessageContentDelta' + - title: SQL + type: object + description: The SQL content that is part of a message. + properties: + statement_delta: + type: string + description: The delta of the sql statement, clients should concatenate + all deltas for the same index + example: SELECT store, SUM(profit) FROM sales GROUP BY store + required: + - statement_delta + MessageContentDeltaSuggestionsObject: + allOf: + - $ref: '#/components/schemas/MessageContentDelta' + - title: Suggested Questions + type: object + description: If SQL cannot be generated, a list of questions the semantic + model can generate SQL for. + properties: + suggestions_delta: + $ref: '#/components/schemas/SuggestionDelta' + required: + - suggestions_delta + SuggestionDelta: + type: object + properties: + index: + type: integer + description: The index of the suggestions array this delta object represents + suggestion_delta: + type: string + description: The delta of a suggestion text, clients should concatenate + all deltas for the same index + StreamingError: + type: object + properties: + message: + type: string + description: A description of the error + code: + type: string + description: The Snowflake error code categorizing the error + request_id: + type: string + description: Unique request ID + SendMessageResponse: + type: object + description: The non-streaming response object for the sendMessage + properties: + message: + $ref: '#/components/schemas/MessageObject' + request_id: + type: string + description: Unique request ID + required: + - message + MessageObject: + type: object + title: The message object + description: Represents a message within a chat. + properties: + role: + description: The entity that produced the message. One of `user` or `analyst`. + type: string + enum: + - user + - analyst + content: + description: The content of the message in array of text or SQL. + type: array + items: + $ref: '#/components/schemas/MessageContent' + required: + - content + MessageContent: + type: object + properties: + type: + type: string + enum: + - text + - sql + - suggestions + discriminator: + propertyName: type + mapping: + text: '#/components/schemas/MessageContentTextObject' + sql: '#/components/schemas/MessageContentSqlObject' + suggestions: '#/components/schemas/MessageContentSuggestionsObject' + MessageContentTextObject: + allOf: + - $ref: '#/components/schemas/MessageContent' + - title: Text + type: object + description: The text content that is part of a message. + properties: + text: + type: string + example: To answer the question "What is the profit per store?" we must + aggregate sales at the store level + required: + - text + MessageContentSqlObject: + allOf: + - $ref: '#/components/schemas/MessageContent' + - title: SQL + type: object + description: The SQL content that is part of a message. + properties: + statement: + type: string + description: The executable SQL statement + example: SELECT store, SUM(profit) FROM sales GROUP BY store + required: + - statement + MessageContentSuggestionsObject: + allOf: + - $ref: '#/components/schemas/MessageContent' + - title: Suggested Questions + type: object + description: If SQL cannot be generated, a list of questions the semantic + model can generate SQL for. + properties: + suggestions: + type: array + items: + type: string + example: What is the lifetime revenue for the top 5 clients? + required: + - suggestions + SendMessageRequest: + type: object + description: The request object for sendMessage requests + properties: + semantic_model_file: + type: string + description: The path to a file stored in a Snowflake Stage holding the + semantic model yaml. Must be in the database and schema provided in the + url parameters. + example: '@my_stage/my_semantic_model.yaml' + semantic_model: + type: string + description: A string containing the entire semantic model yaml + example: 'name: my_semantic_model\ntables:\n - name: orders\n...' + stream: + type: boolean + description: Whether to stream the response or not + default: false + messages: + type: array + items: + $ref: '#/components/schemas/MessageObject' + required: + - messages +tags: +- name: cortex-analyst diff --git a/public-preview/8.30/specification/cortex-inference.yaml b/public-preview/8.30/specification/cortex-inference.yaml new file mode 100644 index 0000000..23bd267 --- /dev/null +++ b/public-preview/8.30/specification/cortex-inference.yaml @@ -0,0 +1,152 @@ +openapi: 3.0.2 +info: + title: Cortex Inference API + description: OpenAPI 3.0 specification for the Cortex REST API + version: 0.1.0 + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/cortex/inference:complete: + post: + summary: Perform LLM text completion inference. + tags: + - cortex-inference + description: Perform LLM text completion inference, similar to snowflake.cortex.Complete. + operationId: cortexLLMInferenceComplete + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CompleteRequest' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/NonStreamingCompleteResponse' + text/event-stream: + schema: + $ref: '#/components/schemas/StreamingCompleteResponse' + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +components: + schemas: + CompleteRequest: + type: object + description: LLM text completion request. + properties: + model: + description: The model name. See documentation for possible values. + type: string + messages: + type: array + items: + type: object + properties: + content: + type: string + description: The text completion prompt, e.g. 'What is a Large Language + Model?'. + required: + - content + minItems: 1 + maxItems: 1 + stream: + description: If true, the response content is streamed as JSON-structured + server-sent events. If false, a single JSON response is returned. + type: boolean + default: false + temperature: + description: Temperature controls the amount of randomness used in response + generation. A higher temperature corresponds to more randomness. + type: number + default: 0 + minimum: 0.0 + top_p: + description: Threshold probability for nucleus sampling. A higher top-p + value increases the diversity of tokens that the model considers, while + a lower value results in more predictable output. + type: number + default: 1.0 + minimum: 0.0 + maximum: 1.0 + max_output_tokens: + description: The maximum number of output tokens to produce. The default + value is model-dependent. + type: integer + default: 4096 + minimum: 0 + required: + - model + - messages + NonStreamingCompleteResponse: + type: object + description: Text-completion response for non-streaming request. + properties: + choices: + type: array + items: + type: object + properties: + message: + type: object + properties: + content: + type: string + description: The text completion response. + usage: + type: object + title: Usage + properties: + prompt_tokens: + type: integer + description: Input token count. + completion_tokens: + type: integer + description: Output token count. + total_tokens: + type: integer + description: Sum of prompt_tokens and completion_tokens. + required: + - texts + StreamingCompleteResponse: + type: object + description: Server-sent events for streaming text-completion updates. + x-events: + data: + $ref: '#/components/schemas/StreamingCompleteResponseDataEvent' + StreamingCompleteResponseDataEvent: + type: object + description: Streaming text-completion response event. + properties: + choices: + type: array + items: + type: object + properties: + delta: + type: object + properties: + content: + type: string + description: Change in text-completion response content since + previous event. +tags: +- name: cortex-inference diff --git a/public-preview/8.30/specification/cortex-search-service.yaml b/public-preview/8.30/specification/cortex-search-service.yaml new file mode 100644 index 0000000..9d6ce82 --- /dev/null +++ b/public-preview/8.30/specification/cortex-search-service.yaml @@ -0,0 +1,104 @@ +openapi: 3.0.1 +info: + title: Cortex Search REST API + description: OpenAPI 3.0 specification for the Cortex Search REST API + version: 0.1.0 + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/databases/{database}/schemas/{schema}/cortex-search-services/{service_name}:query: + post: + summary: Query a Cortex Search Service. + tags: + - cortex-search-service + description: Query a Cortex Search Service to get search results. + operationId: queryCortexSearchService + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - in: path + name: service_name + required: true + schema: + type: string + description: The name of the Cortex Search Service. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/QueryRequest' + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/QueryResponse' + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +components: + schemas: + QueryRequest: + type: object + description: A search query and additional parameters for search. + properties: + query: + description: Unstructured text query. + type: string + columns: + description: List of columns to return. + type: array + items: + type: string + filter: + description: Filter query. + type: object + limit: + description: Max number of results to return. + type: integer + default: 10 + experimental: + description: Opaque container for experimental features. You probably do + not want to use this. + type: object + additionalProperties: true + required: + - query + - columns + QueryResponse: + type: object + description: Search results. + properties: + results: + type: array + description: List of result rows. + items: + type: object + additionalProperties: true + description: Map of column names to bytes. + request_id: + type: string + description: ID of the request. + required: + - results + - request_id +tags: +- name: cortex-search-service diff --git a/public-preview/8.30/specification/database.yaml b/public-preview/8.30/specification/database.yaml new file mode 100644 index 0000000..621b5f6 --- /dev/null +++ b/public-preview/8.30/specification/database.yaml @@ -0,0 +1,793 @@ +openapi: 3.0.0 +servers: +- description: Snowflake Database API + url: https://org-account.snowflakecomputing.com +info: + version: 0.0.1 + title: Snowflake Database API + description: The Snowflake Database API is a REST API that you can use to access, + update, and perform certain actions on Database resource in Snowflake. + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/databases: + get: + summary: Lists databases. + tags: + - database + description: Lists the accessible databases. + operationId: listDatabases + parameters: + - $ref: common.yaml#/components/parameters/like + - $ref: common.yaml#/components/parameters/startsWith + - $ref: common.yaml#/components/parameters/showLimit + - $ref: common.yaml#/components/parameters/fromName + - name: history + in: query + description: Optionally includes dropped databases that have not yet been + purged. + schema: + type: boolean + responses: + '200': + description: Successful request. + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Database' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + post: + summary: Creates a database. + tags: + - database + description: Creates a database, with modifiers as query parameters. You must + provide the full database definition when creating a database. + operationId: createDatabase + parameters: + - $ref: common.yaml#/components/parameters/createMode + - name: kind + in: query + description: Type of database to create. Currently, Snowflake supports only + `transient` and `permanent` (also represented by the empty string). + schema: + type: string + deprecated: true + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Database' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases:from-share: + post: + summary: Creates a database from a share. + tags: + - database + description: Creates a database from a given share. + operationId: createDatabaseFromShare + parameters: + - $ref: common.yaml#/components/parameters/createMode + - name: share + in: query + description: ID of the share from which to create the database, in the form + ".". + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DatabaseFromShare' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{name}:from_share: + post: + summary: Creates a database from a share. + tags: + - database + description: Creates a database from a given share. + operationId: createDatabaseFromShareDeprecated + parameters: + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/createMode + - name: share + in: query + description: ID of the share from which to create the database, in the form + ".". + schema: + type: string + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + deprecated: true + /api/v2/databases/{name}:clone: + post: + summary: Clones a database. + tags: + - database + description: Clones an existing database, with modifiers as query parameters. + You must provide the full database definition when cloning an existing database. + operationId: cloneDatabase + parameters: + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/createMode + - name: kind + in: query + description: Type of database to create. Currently, Snowflake supports only + `transient` and `permanent` (also represented by the empty string). + schema: + type: string + deprecated: true + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DatabaseClone' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{name}: + get: + tags: + - database + description: Fetches a database. + operationId: fetchDatabase + parameters: + - $ref: common.yaml#/components/parameters/name + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + $ref: '#/components/schemas/Database' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + put: + summary: Creates a new, or alters an existing, database. + tags: + - database + description: Creates a new, or alters an existing, database. You must provide + the full database definition even when altering an existing database. + operationId: createOrAlterDatabase + parameters: + - $ref: common.yaml#/components/parameters/name + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Database' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + delete: + summary: Deletes a database. + tags: + - database + description: Deletes the specified database. If you enable the `ifExists` parameter, + the operation succeeds even if the database does not exist. Otherwise, a 404 + failure is returned if the database does not exist. if the drop is unsuccessful. + operationId: deleteDatabase + parameters: + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/ifExists + - name: restrict + in: query + description: 'Whether to drop the database if foreign keys exist that reference + any tables in the database. + + - `true`: Return a warning about existing foreign key references and don''t + drop the database. + + - `false`: Drop the database and all objects in the database, including + tables with primary or unique keys that are referenced by foreign keys in + other tables.' + schema: + type: boolean + default: false + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{name}/replication:enable: + post: + summary: Enables database replication. + tags: + - database + description: Promotes a local database to serve as a primary database for replication. + A primary database can be replicated in one or more accounts, allowing users + in those accounts to query objects in each secondary (i.e. replica) database. + operationId: enableDatabaseReplication + parameters: + - $ref: common.yaml#/components/parameters/name + - name: ignore_edition_check + in: query + description: 'Whether to allow replicating data to accounts on lower editions. + Default: `true`. + + For more information, see the + ALTER DATABASE reference.' + schema: + type: boolean + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AccountIdentifiers' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{name}/replication:disable: + post: + summary: Disables database replication. + tags: + - database + description: Disables replication for this primary database, meaning no replica + of this database (i.e. secondary database) in another account can be refreshed. + Any secondary databases remain linked to the primary database, but requests + to refresh a secondary database are denied. + operationId: disableDatabaseReplication + parameters: + - $ref: common.yaml#/components/parameters/name + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountIdentifiers' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{name}/replication:refresh: + post: + summary: Refreshes database replications. + tags: + - database + description: 'Refreshes a secondary database from a snapshot of its primary + database. A snapshot includes changes to the objects and data. + + If you call this endpoint while another refresh for the same replica database + is running, it fails and returns an error. Snowflake ensures only one refresh + is executed at any given time.' + operationId: refreshDatabaseReplication + parameters: + - $ref: common.yaml#/components/parameters/name + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{name}/failover:enable: + post: + summary: Enables database failover. + tags: + - database + description: Specifies a comma-separated list of accounts in your organization + where a replica of this primary database can be promoted to serve as the primary + database. + operationId: enableDatabaseFailover + parameters: + - $ref: common.yaml#/components/parameters/name + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AccountIdentifiers' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{name}/failover:disable: + post: + summary: Disables database failover. + tags: + - database + description: Disables failover for this primary database, meaning no replica + of this database (i.e. secondary database) can be promoted to serve as the + primary database. + operationId: disableDatabaseFailover + parameters: + - $ref: common.yaml#/components/parameters/name + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountIdentifiers' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{name}/failover:primary: + post: + summary: Sets a primary database. + tags: + - database + description: Promotes the specified secondary (replica) database to serve as + the primary database. When promoted, the database becomes writeable. At the + same time, the previous primary database becomes a read-only secondary database. + operationId: primaryDatabaseFailover + parameters: + - $ref: common.yaml#/components/parameters/name + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +components: + schemas: + AccountIdentifiers: + type: object + description: Array of unique account identifiers. + properties: + accounts: + type: array + items: + type: string + minLength: 1 + example: + accounts: + - accountName1 + - accountName2 + required: + - accounts + Database: + type: object + description: Snowflake database object. + properties: + created_on: + type: string + format: date-time + readOnly: true + description: Date and time the database was created. + name: + $ref: ./common.yaml#/components/schemas/Identifier + description: Name of the database. + kind: + type: string + enum: + - PERMANENT + - TRANSIENT + default: PERMANENT + description: Database type, permanent (default) or transient. + is_default: + type: boolean + readOnly: true + description: Whether the database is the default database for a user. + is_current: + type: boolean + readOnly: true + description: Current database for the session. + origin: + type: string + readOnly: true + owner: + type: string + readOnly: true + description: Name of the role that owns the database. + comment: + type: string + description: Optional comment in which to store information related to the + database. + options: + type: string + readOnly: true + retention_time: + type: integer + readOnly: true + description: Number of days that historical data is retained for Time Travel. + dropped_on: + type: string + format: date-time + readOnly: true + nullable: true + description: Date and time the database was dropped. + budget: + type: string + readOnly: true + description: Budget that defines a monthly spending limit on the compute + costs for a Snowflake account or a custom group of Snowflake objects. + owner_role_type: + type: string + readOnly: true + description: Type of role that owns the object, either ROLE or DATABASE_ROLE + data_retention_time_in_days: + type: integer + description: Specifies the number of days for which Time Travel actions + (CLONE and UNDROP) can be performed on the database, as well as specifying + the default Time Travel retention time for all schemas created in the + database. + default_ddl_collation: + type: string + description: Default collation specification for all schemas and tables + added to the database. You an override the default at the schema and individual + table levels. + log_level: + type: string + description: Severity level of messages that should be ingested and made + available in the active event table. Currently, Snowflake supports only + `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`, `FATAL` and `OFF`. + max_data_extension_time_in_days: + type: integer + description: Maximum number of days for which Snowflake can extend the data + retention period for tables in the database to prevent streams on the + tables from becoming stale. + suspend_task_after_num_failures: + type: integer + description: Maximum number of consecutive failed task runs before the current + task is suspended automatically. + trace_level: + type: string + description: How trace events are ingested into the event table. Currently, + Snowflake supports only `ALWAYS`, `ON_EVENT`, and `OFF`. + user_task_managed_initial_warehouse_size: + type: string + description: Size of the compute resources to provision for the first run + of the task, before a task history is available for Snowflake to determine + an ideal size. + user_task_timeout_ms: + type: integer + description: Time limit, in milliseconds, for a single run of the task before + it times out. + required: + - name + DatabaseClone: + type: object + description: Clone database. + allOf: + - $ref: '#/components/schemas/Database' + properties: + point_of_time: + $ref: common.yaml#/components/schemas/PointOfTime + DatabaseFromShare: + type: object + description: Database from share. + properties: + name: + $ref: ./common.yaml#/components/schemas/Identifier + description: Name of the database. +tags: +- name: database diff --git a/public-preview/8.30/specification/dynamic-table.yaml b/public-preview/8.30/specification/dynamic-table.yaml new file mode 100644 index 0000000..02945bf --- /dev/null +++ b/public-preview/8.30/specification/dynamic-table.yaml @@ -0,0 +1,722 @@ +openapi: 3.0.0 +servers: +- description: Snowflake Dynamic Table API + url: https://org-account.snowflakecomputing.com +info: + version: 0.0.1 + title: Snowflake Dynamic Table API + description: The Snowflake Dynamic Table API is a REST API that you can use to access, + update, and perform certain actions on Dynamic Tables resource in a Snowflake + database. + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/databases/{database}/schemas/{schema}/dynamic-tables: + get: + summary: List dynamic tables + tags: + - dynamic-table + description: Lists the dynamic tables under the database and schema. + operationId: listDynamicTables + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/like + - $ref: common.yaml#/components/parameters/startsWith + - $ref: common.yaml#/components/parameters/showLimit + - $ref: common.yaml#/components/parameters/fromName + - name: deep + description: Optionally includes dependency information of the dynamic table. + in: query + required: false + schema: + type: boolean + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DynamicTable' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + post: + summary: Create a dynamic table + tags: + - dynamic-table + description: Create a dynamic table, with standard create modifiers as query + parameters. See the Dynamic Table component definition for what is required + to be provided in the request body. + operationId: createDynamicTable + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/createMode + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DynamicTable' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}: + get: + summary: Fetch a dynamic table. + tags: + - dynamic-table + description: Fetch a Dynamic Table. + operationId: fetchDynamicTable + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + $ref: '#/components/schemas/DynamicTable' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + delete: + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/ifExists + summary: Delete a dynamic table + tags: + - dynamic-table + description: Delete a dynamic table 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. + operationId: deleteDynamicTable + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:clone: + post: + summary: Clone dynamic table + tags: + - dynamic-table + description: Create a new dynamic table by cloning from the specified resource + operationId: cloneDynamicTable + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/createMode + - $ref: common.yaml#/components/parameters/copyGrants + - name: targetDatabase + in: query + description: Database of the newly created dynamic table. Defaults to the + source table's database. + schema: + $ref: ./common.yaml#/components/schemas/Identifier + - name: targetSchema + in: query + description: Schema of the newly created dynamic table. Defaults to the source + table's schema. + schema: + $ref: ./common.yaml#/components/schemas/Identifier + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DynamicTableClone' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:undrop: + post: + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + summary: Undrop a dynamic table + tags: + - dynamic-table + description: Undrop specified dynamic table + operationId: undropDynamicTable + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:suspend: + post: + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/ifExists + summary: Suspend refreshes on the dynamic table + tags: + - dynamic-table + description: Suspend refreshes on the dynamic table + operationId: suspendDynamicTable + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:resume: + post: + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/ifExists + summary: Resume refreshes on the dynamic table + tags: + - dynamic-table + description: Resume refreshes on the dynamic table + operationId: resumeDynamicTable + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:refresh: + post: + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/ifExists + summary: Refresh the dynamic table + tags: + - dynamic-table + description: Specifies that the dynamic table should be manually refreshed + operationId: refreshDynamicTable + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:suspend-recluster: + post: + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/ifExists + summary: Suspend recluster of a dynamic table + tags: + - dynamic-table + description: Suspend recluster of a dynamic table + operationId: suspendReclusterDynamicTable + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:resume-recluster: + post: + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/ifExists + summary: Resume recluster of a dynamic table + tags: + - dynamic-table + description: Resume recluster of a dynamic table + operationId: resumeReclusterDynamicTable + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/dynamic-tables/{name}:swap-with: + post: + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/ifExists + - name: targetName + description: The fully-specified name of the target dynamic table to be swapped + with. + in: query + required: true + schema: + type: string + summary: Swap with another dynamic table + tags: + - dynamic-table + description: Swap with another dynamic table + operationId: swapWithDynamicTable + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +components: + schemas: + DynamicTable: + type: object + description: A Snowflake dynamic table object. + properties: + name: + type: string + description: Specifies the name for the dynamic table, must be unique for + the schema in which the dynamic table is created + kind: + type: string + enum: + - PERMANENT + - TRANSIENT + default: PERMANENT + description: Specifies the dynamic table type, permanent (default) or transient. + columns: + type: array + items: + $ref: '#/components/schemas/DynamicTableColumn' + target_lag: + $ref: '#/components/schemas/TargetLag' + refresh_mode: + type: string + description: Specifies the refresh type for the dynamic table + enum: + - AUTO + - FULL + - INCREMENTAL + initialize: + type: string + description: Specifies the behavior of the initial refresh of the dynamic + table + enum: + - ON_CREATE + - ON_SCHEDULE + warehouse: + type: string + description: Specifies the name of the warehouse that provides the compute + resources for refreshing the dynamic table + example: test_wh + cluster_by: + type: array + description: Specifies one or more columns or column expressions in the + dynamic table as the clustering key + items: + type: string + query: + type: string + description: Specifies the query whose results the dynamic table should + contain + example: SELECT * FROM foo + data_retention_time_in_days: + type: integer + description: Specifies the retention period for the dynamic table so that + Time Travel actions (SELECT, CLONE) can be performed on historical data + in the dynamic table + max_data_extension_time_in_days: + type: integer + description: Specifies the retention period for the dynamic table so that + Time Travel actions (SELECT, CLONE) can be performed on historical data + in the dynamic table + comment: + type: string + description: Specifies a comment for the dynamic table. + created_on: + type: string + format: date-time + readOnly: true + description: Date and time when the dynamic table was created. + database_name: + type: string + readOnly: true + description: Database in which the dynamic table is stored + schema_name: + type: string + readOnly: true + description: Schema in which the dynamic table is stored + rows: + type: integer + format: int64 + readOnly: true + description: Number of rows in the dynamic table. + bytes: + type: integer + format: int64 + readOnly: true + description: Number of bytes that will be scanned if the entire table is + scanned in a query. Note that this number may be different than the number + of actual physical bytes stored on-disk for the table + scheduling_state: + type: string + enum: + - RUNNING + - SUSPENDED + readOnly: true + description: Scheduling state (RUNNING or SUSPENDED) + automatic_clustering: + type: boolean + readOnly: true + description: If Automatic Clustering is enabled for your account, specifies + whether it is explicitly enabled or disabled for the dynamic table. + owner: + type: string + readOnly: true + description: Role that owns the table + owner_role_type: + type: string + readOnly: true + description: The type of role that owns the object. + budget: + type: string + readOnly: true + description: Name of the budget if the object is monitored by a budget + required: + - name + - target_lag + - warehouse + - query + DynamicTableColumn: + type: object + description: A column in the dynamic table + properties: + name: + type: string + description: Column name + datatype: + type: string + description: The data type for the column + comment: + type: string + description: Specifies a comment for the column + required: + - name + TargetLag: + type: object + description: Specifies the schedule for periodically running the task. + properties: + type: + description: Type of lag, can be either USER_DEFINED or DOWNSTREAM. + type: string + discriminator: + propertyName: type + mapping: + USER_DEFINED: UserDefinedLag + DOWNSTREAM: DownstreamLag + UserDefinedLag: + description: User-defined target lag. + allOf: + - $ref: '#/components/schemas/TargetLag' + properties: + seconds: + type: integer + format: int64 + description: Target lag time in seconds. + example: + seconds: 3600 + required: + - seconds + DownstreamLag: + description: Downstream target lag + allOf: + - $ref: '#/components/schemas/TargetLag' + DynamicTableClone: + type: object + description: Clone dynamic table + properties: + name: + type: string + description: Specifies the name for the dynamic table, must be unique for + the schema in which the dynamic table is created + target_lag: + $ref: '#/components/schemas/TargetLag' + warehouse: + type: string + description: Specifies the name of the warehouse that provides the compute + resources for refreshing the dynamic table + point_of_time: + $ref: common.yaml#/components/schemas/PointOfTime + required: + - name +tags: +- name: dynamic-table diff --git a/public-preview/8.30/specification/function.yaml b/public-preview/8.30/specification/function.yaml new file mode 100644 index 0000000..6ec1fe6 --- /dev/null +++ b/public-preview/8.30/specification/function.yaml @@ -0,0 +1,324 @@ +openapi: 3.0.0 +servers: +- description: Snowflake REST Server + url: https://org-account.snowflakecomputing.com +info: + version: 0.0.1 + title: Snowflake Function API + description: The Snowflake Function API is a REST API that allows caller to create, + execute and drop functions in a Snowflake database. + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/databases/{database}/schemas/{schema}/functions: + get: + summary: List Functions + tags: + - function + description: Lists the user functions under the database and schema. + operationId: listFunctions + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/like + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Function' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + post: + summary: Create a Function + tags: + - function + description: Create a function. + operationId: createFunction + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/createMode + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Function' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/functions/{nameWithArgs}: + get: + summary: Fetch a Function. + tags: + - function + description: Fetch a Function using the describe command output. + operationId: fetchFunction + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/nameWithArgs + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + $ref: '#/components/schemas/Function' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + delete: + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/nameWithArgs + - $ref: common.yaml#/components/parameters/ifExists + summary: Delete a function + tags: + - function + description: Delete a function with the given name and args. + operationId: deleteFunction + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/functions/{name}:execute: + post: + summary: Execute a Function. + tags: + - function + description: Execute a Function. + operationId: executeFunction + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/FunctionArguments' + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + type: object + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +components: + schemas: + Function: + type: object + description: A Snowflake function + discriminator: + propertyName: function_type + mapping: + service-function: '#/components/schemas/ServiceFunction' + properties: + function_type: + type: string + default: service-function + name: + type: string + description: Specifies the name for the function, must be unique for the + schema in which the function is created + arguments: + type: array + items: + $ref: '#/components/schemas/FunctionArgument' + returns: + type: string + description: Specifies the type for the function return value. + enum: + - FIXED + - INT + - REAL + - NUMBER + - TEXT + - BOOLEAN + - DATE + - TIME + - TIMESTAMP_TZ + - TIMESTAMP_LTZ + - TIMESTAMP_NTZ + default: TEXT + max_batch_rows: + type: integer + description: Specifies the max rows for batch operation. + created_on: + type: string + format: date-time + description: Date and time when the function was created. + signature: + type: string + description: Function's arguments. + language: + type: string + description: Function's language. + body: + type: string + description: Function's body. + required: + - name + - arguments + FunctionArgument: + type: object + description: An argument of function + properties: + name: + type: string + description: Argument's name + datatype: + description: Argument's type + type: string + enum: + - FIXED + - INT + - REAL + - NUMBER + - TEXT + - BOOLEAN + - DATE + - TIME + - TIMESTAMP_TZ + - TIMESTAMP_LTZ + - TIMESTAMP_NTZ + default: TEXT + value: + description: Argument's value + FunctionArguments: + type: array + items: + $ref: '#/components/schemas/FunctionArgument' + ServiceFunction: + allOf: + - $ref: '#/components/schemas/Function' + description: Service based function + required: + - service + - endpoint + - path + properties: + service: + $ref: ./common.yaml#/components/schemas/Identifier + description: Service's name + endpoint: + type: string + description: Function's endpoint + path: + type: string + description: Function's path +tags: +- name: function diff --git a/public-preview/8.30/specification/grant.yaml b/public-preview/8.30/specification/grant.yaml new file mode 100644 index 0000000..9fabe08 --- /dev/null +++ b/public-preview/8.30/specification/grant.yaml @@ -0,0 +1,481 @@ +openapi: 3.0.0 +servers: +- description: Snowflake REST Server + url: https://org-account.snowflakecomputing.com +info: + version: 0.0.1 + title: Snowflake Grant API + description: The Snowflake Grant API is a REST API that you can use to show or manage + privileges that have been provided to users and roles in a Snowflake database. + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/grants/{granteeType}/{granteeName}/{securableType}/{securableName}/privileges: + post: + summary: Grant the specified privilege(s) on the named securable to the named + grantee. + description: Endpoint to indicate that the privileges listed in the request + body should be granted. + operationId: grantPrivilege + tags: + - grant + parameters: + - $ref: '#/components/parameters/granteeType' + - $ref: '#/components/parameters/granteeName' + - $ref: '#/components/parameters/securableType' + - $ref: '#/components/parameters/securableName' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Grant' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/grants/{granteeType}/{granteeName}/{bulkGrantType}/{securableTypePlural}/{scopeType}/{scopeName}/privileges: + post: + summary: Grant the specified privilege(s) on all/future (as specified by bulkGrantType) + securables of this type in a given scope to the named grantee. + description: Endpoint to indicate that the privileges listed in the request + body should be granted to all securables of this type in the given scope. + operationId: grantGroupPrivilege + tags: + - grant + parameters: + - $ref: '#/components/parameters/granteeType' + - $ref: '#/components/parameters/granteeName' + - $ref: '#/components/parameters/bulkGrantType' + - $ref: '#/components/parameters/securableTypePlural' + - $ref: '#/components/parameters/scopeType' + - $ref: '#/components/parameters/scopeName' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Grant' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/grants/{granteeType}/{granteeName}/{securableType}/{securableName}/privileges/{privilege}: + delete: + summary: Revoke the specified privilege on the named securable from the named + grantee. + description: Endpoint to indicate that the privilege listed in the path should + be revoked. + operationId: revokePrivilege + tags: + - grant + parameters: + - $ref: '#/components/parameters/granteeType' + - $ref: '#/components/parameters/granteeName' + - $ref: '#/components/parameters/securableType' + - $ref: '#/components/parameters/securableName' + - $ref: '#/components/parameters/privilege' + - $ref: '#/components/parameters/deleteMode' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/grants/{granteeType}/{granteeName}/{securableType}/{securableName}/privileges/{privilege}/grant-option: + delete: + summary: Revoke the grant option for the specified privilege on the named securable + from the named grantee. + description: Endpoint to indicate that the grant option for the privilege listed + in the path should be revoked. + operationId: revokePrivilegeGrantOption + tags: + - grant + parameters: + - $ref: '#/components/parameters/granteeType' + - $ref: '#/components/parameters/granteeName' + - $ref: '#/components/parameters/securableType' + - $ref: '#/components/parameters/securableName' + - $ref: '#/components/parameters/privilege' + - $ref: '#/components/parameters/deleteMode' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + ? /api/v2/grants/{granteeType}/{granteeName}/{bulkGrantType}/{securableTypePlural}/{scopeType}/{scopeName}/privileges/{privilege} + : delete: + summary: Revoke the specified privilege on the specified all/future securable + in the given scope from the named grantee. + description: Endpoint to indicate that the privilege listed on the group securable + in the given scope should be revoked. + operationId: revokeGroupPrivilege + tags: + - grant + parameters: + - $ref: '#/components/parameters/granteeType' + - $ref: '#/components/parameters/granteeName' + - $ref: '#/components/parameters/bulkGrantType' + - $ref: '#/components/parameters/securableTypePlural' + - $ref: '#/components/parameters/scopeType' + - $ref: '#/components/parameters/scopeName' + - $ref: '#/components/parameters/privilege' + - $ref: '#/components/parameters/deleteMode' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + ? /api/v2/grants/{granteeType}/{granteeName}/{bulkGrantType}/{securableTypePlural}/{scopeType}/{scopeName}/privileges/{privilege}/grant-option + : delete: + summary: Revoke the grant option for the specified privilege on the specified + all/future securable in the given scope from the named grantee. + description: Endpoint to indicate that the grant option for the privilege listed + on the group securable in the given scope should be revoked. + operationId: revokeGroupPrivilegeGrantOption + tags: + - grant + parameters: + - $ref: '#/components/parameters/granteeType' + - $ref: '#/components/parameters/granteeName' + - $ref: '#/components/parameters/bulkGrantType' + - $ref: '#/components/parameters/securableTypePlural' + - $ref: '#/components/parameters/scopeType' + - $ref: '#/components/parameters/scopeName' + - $ref: '#/components/parameters/privilege' + - $ref: '#/components/parameters/deleteMode' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/grants/{granteeType}/{granteeName}: + get: + summary: List of privileges associated with this grantee type and name + description: List the roles and privileges granted to the specified grantee + using the output of SHOW GRANTS TO + operationId: listGrantsTo + tags: + - grant + parameters: + - $ref: '#/components/parameters/granteeType' + - $ref: '#/components/parameters/granteeName' + - $ref: common.yaml#/components/parameters/showLimit + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Grant' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +components: + parameters: + granteeType: + name: granteeType + description: String that specifies the type of resource that is the privilege + grantee. + required: true + in: path + schema: + example: role + type: string + enum: + - user + - role + - application-role + - database-role + - share + granteeName: + name: granteeName + description: String that specifies the name of the privilege grantee. + required: true + in: path + schema: + example: SYSADMIN + type: string + securableType: + name: securableType + description: String that specifies the type of resource that is being secured + by a privilege. + required: true + in: path + schema: + example: DATABASE + type: string + securableName: + name: securableName + description: String that specifies the name of resource that is being secured + by a privilege. + required: true + in: path + schema: + example: MY_DB + type: string + bulkGrantType: + name: bulkGrantType + description: String that species whether this group privilege should be on ALL + or FUTURE resources of the specified plural type + required: true + in: path + schema: + example: all + type: string + enum: + - all + - future + securableTypePlural: + name: securableTypePlural + description: String that specifies the plural of the type of resource that is + being secured by an ALL/FUTURE privilege. Must be either "schemas" or any + plural object type that can nest under a schema such as "tables" + required: true + in: path + schema: + example: tables + type: string + scopeType: + name: scopeType + description: String that specifies the type of resource that is the scope of + an ALL/FUTURE privilege. Can only be DATABASE or SCHEMA + required: true + in: path + schema: + example: schema + type: string + enum: + - database + - schema + scopeName: + name: scopeName + description: String that specifies the name of resource that is the scope of + an ALL/FUTURE privilege + required: true + in: path + schema: + example: MY_DB.MY_SC + type: string + privilege: + name: privilege + description: String that specifies a privilege to be revoked + required: true + in: path + schema: + example: SELECT + type: string + deleteMode: + name: deleteMode + description: If "cascade", recursively revoke the grant from sub-grantees to + which this privilege was re-granted. Acceptable values are "restrict" or "cascade". + required: false + in: query + schema: + type: string + example: restrict + schemas: + Grant: + description: Properties of a grant that can be granted to a role or user. + type: object + properties: + privileges: + type: array + description: Privilege type + items: + type: string + example: + - CREATE DATABASE + - EXECUTE TASK + grant_option: + type: boolean + description: Can grantee pass this privilege down? + created_on: + type: string + format: date-time + grantee_type: + type: string + description: Entity type being granted to + example: ROLE + grantee_name: + type: string + description: Specific name of object being granted to + example: ACCOUNTADMIN + securable_type: + type: string + description: Type of object granted on + example: ACCOUNT + securable_name: + type: string + description: Name of specific object granted on (not name of privilege!) + granted_by_role_type: + type: string + description: Type of role that granted this privilege to this grantee + example: ROLE + granted_by_name: + type: string + description: The role that granted this privilege to this grantee + example: SUBADMIN +tags: +- name: grant diff --git a/public-preview/8.30/specification/image-repository.yaml b/public-preview/8.30/specification/image-repository.yaml new file mode 100644 index 0000000..76149ef --- /dev/null +++ b/public-preview/8.30/specification/image-repository.yaml @@ -0,0 +1,270 @@ +openapi: 3.0.0 +servers: +- description: Snowflake Image Repository API + url: https://org-account.snowflakecomputing.com +info: + version: 0.0.1 + title: Snowflake Image Repository API + description: The Snowflake Image Repository API is a REST API that you can use to + access, update, and perform common actions on Image Repository resource in Snowflake. + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/databases/{database}/schemas/{schema}/image-repositories: + get: + summary: Lists image repositories. + tags: + - image-repository + description: Lists the image repositories under a specified database and schema. + operationId: listImageRepositories + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/like + responses: + '200': + description: Successful request. + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ImageRepository' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + post: + summary: Creates an image repository in the specified database and schema. + tags: + - image-repository + description: Creates an image repository in the specified database, schema, + and create mode. The `createMode` query parameter specifies what action to + take based on whether the repository already exists. See the ImageRepository + component definition for what is required to be provided in the request body. + operationId: createImageRepository + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/createMode + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ImageRepository' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/image-repositories/{name}: + get: + summary: Fetches an image repository. + tags: + - image-repository + description: Fetches a named image repository in a specified database and schema. + operationId: fetchImageRepository + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + responses: + '200': + description: Successful request. + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + $ref: '#/components/schemas/ImageRepository' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + delete: + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/ifExists + summary: Deletes an image repository. + tags: + - image-repository + description: Deletes an image repository with the given name. If you enable + the `ifExists` query parameter, the operation succeeds even if the object + does not exist. Otherwise, a 404 failure is returned if the object does not + exist. + operationId: deleteImageRepository + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/image-repositories/{name}/images: + get: + summary: List images in the image repository. + tags: + - image-repository + description: List images in the given image repository. + operationId: listImagesInRepository + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + responses: + '200': + description: Successful request. + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + type: object + properties: + images: + type: array + items: + type: string + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +components: + schemas: + ImageRepository: + type: object + description: A Snowflake image repository. + properties: + name: + $ref: ./common.yaml#/components/schemas/Identifier + database_name: + $ref: ./common.yaml#/components/schemas/Identifier + readOnly: true + schema_name: + $ref: ./common.yaml#/components/schemas/Identifier + readOnly: true + created_on: + type: string + description: Time the image repository was created. + format: date-time + readOnly: true + repository_url: + type: string + description: Current URL of the image repository. + readOnly: true + owner: + type: string + description: Identifier for the current owner of the image repository. + readOnly: true + owner_role_type: + type: string + description: Role type of the image repository owner. + readOnly: true + example: + name: image_repository_name + database_name: test_db + schema_name: test_schema + created_on: '2024-06-18T01:01:01.111111' + repository_url: https://www.snowflake.com + owner: IMAGE_ADMIN + owner_role_type: ADMIN + required: + - name +tags: +- name: image-repository diff --git a/public-preview/8.30/specification/result.yaml b/public-preview/8.30/specification/result.yaml new file mode 100644 index 0000000..d9445d4 --- /dev/null +++ b/public-preview/8.30/specification/result.yaml @@ -0,0 +1,68 @@ +openapi: 3.0.0 +servers: +- description: Snowflake Result API + url: https://org-account.snowflakecomputing.com +info: + version: 0.0.1 + title: Snowflake Result API + description: The Snowflake Result API is a REST API that you can use to check request + status and fetch request response. + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/results/{result_handler}: + get: + summary: Check result status or fetch request + tags: + - result + description: Get result status or the result when it is ready. + operationId: fetchResult + parameters: + - name: result_handler + in: path + required: true + schema: + type: string + description: The opaque result id. + - name: page + in: query + required: false + schema: + type: integer + format: int64 + minimum: 0 + default: 0 + description: Number of the page of results to return. The number can range + from 0 to the total number of pages minus 1. + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: {} + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +tags: +- name: result diff --git a/public-preview/8.30/specification/role.yaml b/public-preview/8.30/specification/role.yaml new file mode 100644 index 0000000..9760ac6 --- /dev/null +++ b/public-preview/8.30/specification/role.yaml @@ -0,0 +1,197 @@ +openapi: 3.0.0 +servers: +- description: Snowflake REST Server + url: https://org-account.snowflakecomputing.com +info: + version: 0.0.1 + title: Snowflake Role API + description: The Snowflake Role API is a REST API that you can use to access, update, + and perform certain action on Roles in a Snowflake database. + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/roles: + post: + summary: Create a role + tags: + - role + description: Create a role according to the parameters given + operationId: createRole + parameters: + - $ref: common.yaml#/components/parameters/createMode + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Role' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + get: + summary: List roles available to account + tags: + - role + description: Lists the roles available to the user's account + operationId: listRoles + parameters: + - $ref: common.yaml#/components/parameters/like + - $ref: common.yaml#/components/parameters/startsWith + - $ref: common.yaml#/components/parameters/showLimit + - $ref: common.yaml#/components/parameters/fromName + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Role' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/roles/{name}: + delete: + parameters: + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/ifExists + summary: Delete a role + tags: + - role + description: Delete a role with the given name. + operationId: deleteRole + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +components: + schemas: + Role: + description: Properties of role. + type: object + required: + - name + properties: + name: + type: string + description: Role name + example: accountadmin + comment: + type: string + description: Comment about the role. + example: Account administrator can manage all aspects of the account. + created_on: + type: string + readOnly: true + description: Timestamp for the creation of this role. + format: date-time + is_default: + type: boolean + description: "Specifies whether the role being fetched is the user\u2019\ + s default role." + readOnly: true + is_current: + type: boolean + description: "Specifies whether the role being fetched is the user\u2019\ + s current role." + readOnly: true + is_inherited: + type: boolean + description: Specifies whether the role used to run the command inherits + the specified role. + readOnly: true + assigned_to_users: + type: integer + readOnly: true + description: The number of users to whom this role has been assigned. + format: int64 + granted_to_roles: + type: integer + readOnly: true + description: The number of roles to which this role has been granted. + format: int64 + granted_roles: + type: integer + readOnly: true + description: The number of roles that have been granted to this role. + format: int64 + owner: + type: string + description: Specifies the role that owns this role. + readOnly: true +tags: +- name: role diff --git a/public-preview/8.30/specification/schema.yaml b/public-preview/8.30/specification/schema.yaml new file mode 100644 index 0000000..574f371 --- /dev/null +++ b/public-preview/8.30/specification/schema.yaml @@ -0,0 +1,486 @@ +openapi: 3.0.0 +servers: +- description: Snowflake Schema API + url: https://org-account.snowflakecomputing.com +info: + version: 0.0.1 + title: Snowflake Schema API + description: The Snowflake Schema API is a REST API that you can use to access, + update, and perform certain actions on a Snowflake schema. + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/databases/{database}/schemas: + get: + summary: Lists schemas. + tags: + - schema + description: Lists the accessible schemas. + operationId: listSchemas + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/like + - $ref: common.yaml#/components/parameters/startsWith + - $ref: common.yaml#/components/parameters/showLimit + - $ref: common.yaml#/components/parameters/fromName + - name: history + in: query + description: 'Whether to include dropped schemas that have not yet been purged. + Default: `false`.' + schema: + type: boolean + default: false + responses: + '200': + description: Successful request. + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Schema' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + post: + summary: Creates a schema. + tags: + - schema + description: Creates a schema, with modifiers as query parameters. You must + provide the full schema definition when creating a schema. + operationId: createSchema + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/createMode + - name: kind + in: query + description: Type of schema to create. Currently, Snowflake supports only + `transient` and `permanent` (also represented by the empty string). + schema: + type: string + default: '' + deprecated: true + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Schema' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{name}:clone: + post: + summary: Clones a schema. + tags: + - schema + description: Clones an existing schema, with modifiers as query parameters. + You must provide the full schema definition when cloning an existing schema. + operationId: cloneSchema + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/createMode + - name: kind + in: query + description: Type of schema to clone. Currently, Snowflake supports only `transient` + and `permanent` (also represented by the empty string). + schema: + type: string + default: '' + deprecated: true + - name: targetDatabase + in: query + description: Database of the newly created schema. Defaults to the source + schema's database. + schema: + $ref: ./common.yaml#/components/schemas/Identifier + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SchemaClone' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{name}:undrop: + post: + summary: Undrop a schema. + tags: + - schema + description: Undrops schema. + operationId: undropSchema + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/name + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{name}: + get: + tags: + - schema + description: Fetches a schema. + operationId: fetchSchema + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/name + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + $ref: '#/components/schemas/Schema' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + put: + summary: Creates a new, or alters an existing, schema. + tags: + - schema + description: Creates a new, or alters an existing, schema. You must provide + the full schema definition even when altering an existing schema. + operationId: createOrAlterSchema + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/name + - name: kind + in: query + description: Type of schema to create. Currently, Snowflake supports only + `transient` and `permanent` (also represented by the empty string). + schema: + type: string + default: '' + deprecated: true + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Schema' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + delete: + summary: Deletes a schema. + tags: + - schema + description: Deletes the specified schema. If you enable the `ifExists` parameter, + the operation succeeds even if the schema does not exist. Otherwise, a 404 + failure is returned if the schema does not exist. if the drop is unsuccessful. + operationId: deleteSchema + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/ifExists + - name: restrict + in: query + description: 'Whether to drop the schema if foreign keys exist that reference + any tables in the schema. + + - `true`: Return a warning about existing foreign key references and don''t + drop the schema. + + - `false`: Drop the schema and all objects in the database, including tables + with primary or unique keys that are referenced by foreign keys in other + tables. + + Default: `false`.' + schema: + type: boolean + default: false + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +components: + schemas: + Schema: + type: object + description: Snowflake schema definition. + properties: + created_on: + type: string + format: date-time + readOnly: true + description: Date and time the schema was created. + name: + $ref: ./common.yaml#/components/schemas/Identifier + description: Name of the schema. + kind: + type: string + enum: + - PERMANENT + - TRANSIENT + default: PERMANENT + description: Schema type, permanent (default) or transient. + is_default: + type: boolean + readOnly: true + description: Default schema for a user. + is_current: + type: boolean + readOnly: true + description: Current schema for the session. + database_name: + type: string + readOnly: true + description: Database that the schema belongs to + owner: + type: string + readOnly: true + description: Name of the role that owns the schema. + comment: + type: string + description: Optional comment in which to store information related to the + schema. + options: + type: string + readOnly: true + managed_access: + type: boolean + default: false + description: Whether this schema is a managed access schema that centralizes + privilege management with the schema owner. + retention_time: + type: integer + readOnly: true + description: Number of days that historical data is retained for Time Travel. + dropped_on: + type: string + format: date-time + readOnly: true + nullable: true + description: Date and time the schema was dropped. + owner_role_type: + type: string + readOnly: true + description: Type of role that owns the object, either `ROLE` or `DATABASE_ROLE`. + budget: + type: string + readOnly: true + description: Budget that defines a monthly spending limit on the compute + costs for a Snowflake account or a custom group of Snowflake objects. + data_retention_time_in_days: + type: integer + description: Number of days for which Time Travel actions (CLONE and UNDROP) + can be performed on the schema, as well as specifying the default Time + Travel retention time for all tables created in the schema + default_ddl_collation: + type: string + description: Specifies a default collation specification for all tables + added to the schema. You an override the default at the schema and individual + table levels. + log_level: + type: string + description: Severity level of messages that should be ingested and made + available in the active event table. Currently, Snowflake supports only + `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`, `FATAL` and `OFF`. + pipe_execution_paused: + type: boolean + description: Whether pipe execution is paused. + max_data_extension_time_in_days: + type: integer + description: Maximum number of days for which Snowflake can extend the data + retention period for tables in the schema to prevent streams on the tables + from becoming stale. + suspend_task_after_num_failures: + type: integer + description: Specifies the number of consecutive failed task runs after + which the current task is suspended automatically. + trace_level: + type: string + description: How trace events are ingested into the event table. Currently, + Snowflake supports only `ALWAYS`, `ON_EVENT`, and `OFF`. + user_task_managed_initial_warehouse_size: + type: string + description: Size of the compute resources to provision for the first run + of the task, before a task history is available for Snowflake to determine + an ideal size. + user_task_timeout_ms: + type: integer + description: Time limit, in milliseconds, for a single run of the task before + it times out. + required: + - name + SchemaClone: + type: object + description: Schema clone definition. + allOf: + - $ref: '#/components/schemas/Schema' + properties: + point_of_time: + $ref: common.yaml#/components/schemas/PointOfTime +tags: +- name: schema diff --git a/public-preview/8.30/specification/service.yaml b/public-preview/8.30/specification/service.yaml new file mode 100644 index 0000000..924aff4 --- /dev/null +++ b/public-preview/8.30/specification/service.yaml @@ -0,0 +1,556 @@ +openapi: 3.0.0 +servers: +- description: Snowflake Services API + url: https://org-account.snowflakecomputing.com +info: + version: 0.0.1 + title: 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. + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/databases/{database}/schemas/{schema}/services: + get: + summary: List services + tags: + - service + description: Lists the services under the database and schema. + operationId: listServices + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/like + - $ref: common.yaml#/components/parameters/startsWith + - $ref: common.yaml#/components/parameters/showLimit + - $ref: common.yaml#/components/parameters/fromName + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Service' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + post: + summary: Create a service + tags: + - service + 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. + operationId: createService + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - name: createMode + 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.' + in: query + schema: + type: string + enum: + - errorIfExists + - ifNotExists + example: errorIfExists + default: errorIfExists + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Service' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/services/{name}: + get: + description: Fetch a service. + tags: + - service + operationId: fetchService + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + $ref: '#/components/schemas/Service' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + delete: + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/ifExists + summary: Delete a service + tags: + - service + 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. + operationId: deleteService + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/services/{name}/logs: + get: + description: Fetch the logs for a given service. + tags: + - service + operationId: fetchServiceLogs + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - in: query + name: instanceId + description: ID of the service instance, starting with 0. + required: true + schema: + type: integer + - in: query + name: containerName + description: Container name as specified in the service specification file. + required: true + schema: + type: string + - in: query + name: numLines + schema: + type: integer + description: Number of trailing log lines to retrieve. + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + type: object + properties: + system$get_service_logs: + type: string + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/services/{name}/status: + get: + description: Fetch the status for a given service. + tags: + - service + operationId: fetchServiceStatus + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - in: query + name: timeout + schema: + type: integer + 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. + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + type: object + properties: + system$get_service_status: + type: string + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/services/{name}:resume: + post: + description: Resume a service. + tags: + - service + operationId: resumeService + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/ifExists + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/services/{name}:suspend: + post: + description: Suspend a service. + tags: + - service + operationId: suspendService + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/ifExists + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/services/{name}/endpoints: + get: + summary: List the endpoints in a service. + description: Lists the endpoints in a Snowpark Container Services service (or + a job service). + tags: + - service + operationId: showServiceEndpoints + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ServiceEndpoint' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +components: + schemas: + ServiceSpecInlineText: + description: Specifies service specification with inline text. + allOf: + - $ref: '#/components/schemas/ServiceSpec' + properties: + spec_text: + type: string + description: Specifies service specification. You can use a pair of dollar + signs ($$) to delimit the beginning and ending of the specification string. + required: + - spec_text + ServiceSpecStageFile: + description: Specifies service specification with a stage file. + allOf: + - $ref: '#/components/schemas/ServiceSpec' + properties: + stage: + type: string + description: Specifies the Snowflake internal stage where the specification + file is stored; for example, @tutorial_stage. + spec_file: + type: string + description: Specifies the path to the service specification file on the + stage; for example, 'some-dir/echo_spec.yaml'. + required: + - stage + - spec_file + ServiceSpec: + type: object + description: Specifies service specification. + properties: + spec_type: + type: string + description: Type of the service specification, can be `from_file` or `from_inline`. + discriminator: + propertyName: spec_type + mapping: + from_file: ServiceSpecStageFile + from_inline: ServiceSpecInlineText + writeOnly: true + Service: + type: object + description: A Snowflake service object. + properties: + name: + $ref: ./common.yaml#/components/schemas/Identifier + description: String that specifies the identifier (that is, the name) for + the service. + compute_pool: + type: string + description: Specifies the name of the compute pool in your account on which + to run the service. + spec: + $ref: '#/components/schemas/ServiceSpec' + description: Specifies service specification. + external_access_integrations: + type: array + description: Specifies the names of the external access integrations that + allow your service to access external sites. + items: + type: string + auto_resume: + type: boolean + description: Specifies whether to automatically resume a service when a + service function or ingress is called. + min_instances: + type: integer + description: Specifies the minimum number of service instances to run. + max_instances: + type: integer + description: Specifies the maximum number of service instances to run. + query_warehouse: + $ref: ./common.yaml#/components/schemas/Identifier + description: Warehouse to use if a service container connects to Snowflake + to execute a query but does not explicitly specify a warehouse to use. + comment: + type: string + description: Specifies a comment for the service. + database_name: + $ref: ./common.yaml#/components/schemas/Identifier + description: The name of the parent database for the service. + readOnly: true + schema_name: + $ref: ./common.yaml#/components/schemas/Identifier + description: The name of the parent schema for the service. + readOnly: true + owner: + type: string + description: Role that owns the service. + readOnly: true + dns_name: + type: string + description: Snowflake-assiged DNS name of the service. The DNS name enables + service-to-service communications. + readOnly: true + created_on: + type: string + description: Timestamp when the service was created. + format: date-time + readOnly: true + updated_on: + type: string + description: Timestamp when the service was last updated. + format: date-time + readOnly: true + resumed_on: + type: string + description: Timestamp when the service was last resumed. + format: date-time + readOnly: true + owner_role_type: + type: string + description: The role type of the service owner. + readOnly: true + required: + - name + - compute_pool + - spec + example: + name: service_name + compute_pool: compute_pool_name + spec: + spec_type: from_file + stage: '@stage_name' + spec_file: spec_file.yaml + ServiceEndpoint: + type: object + properties: + name: + type: string + port: + type: integer + protocol: + type: string + is_public: + type: boolean + ingress_url: + type: string +tags: +- name: service diff --git a/public-preview/8.30/specification/stage.yaml b/public-preview/8.30/specification/stage.yaml new file mode 100644 index 0000000..5678b3a --- /dev/null +++ b/public-preview/8.30/specification/stage.yaml @@ -0,0 +1,502 @@ +openapi: 3.0.0 +servers: +- description: Snowflake Stage API + url: https://org-account.snowflakecomputing.com +info: + version: 0.0.1 + title: Snowflake Stage API + description: The Snowflake Stage API is a REST API that you can use to access, update, + and perform certain actions on stage resources in a Snowflake database. + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/databases/{database}/schemas/{schema}/stages: + get: + summary: List stages + tags: + - stage + description: Lists stages under the database and schema, with show options as + query parameters. + operationId: listStages + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/like + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Stage' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + post: + summary: Create a stage + tags: + - stage + description: Create a stage, with standard create modifiers as query parameters. + See the Stage component definition for what is required to be provided in + the request body. + operationId: createStage + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/createMode + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Stage' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/stages/{name}: + get: + summary: Fetch a stage + tags: + - stage + description: Fetch a stage using the describe command output. + operationId: fetchStage + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + $ref: '#/components/schemas/Stage' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + delete: + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/ifExists + summary: Delete a stage + tags: + - stage + description: Delete a stage with the stage 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. + operationId: deleteStage + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/stages/{name}/files: + get: + summary: List files in the stage. + tags: + - stage + description: List files in the stage -- this is equivalent to LIST @stage. + operationId: listFiles + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/pattern + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/StageFile' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/stages/{name}/files/{filePath}:presigned-url: + post: + summary: Generate a presigned url and optionally encryption materials. + tags: + - stage + description: Generate a presigned url and optionally encryption materials for + uploading and downloading files. + operationId: getPresignedUrl + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - name: filePath + description: The full stage path of the file. + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PresignedUrlRequest' + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + $ref: '#/components/schemas/FileTransferMaterial' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +components: + schemas: + PresignedUrlRequest: + type: object + description: Request object to get presigned url of a file + properties: + mode: + type: string + description: Indicates whether the presigned url is used for file uploading + or downloading. Can be `upload` or `download`. Default to `download`. + enum: + - upload + - download + default: download + expiration_time: + description: Expiration time of the generated presigned url in seconds. + type: integer + FileTransferMaterial: + type: object + description: Materials for uploading and downloading stage files + properties: + presigned_url: + type: string + description: Presigned url for file transfer. + query_stage_master_key: + type: string + description: Query stage master key for client side file encryption. NULL + if the stage does not use client encryption. + query_id: + type: string + description: Query id for client side file encryption. NULL if the stage + does not use client encryption or the presigned_url is used for downloading. + smk_id: + type: integer + format: int64 + description: SMK id for client side file encryption. NULL if the stage does + not use client encryption or the presigned_url is used for downloading. + StageFile: + type: object + description: A file on a snowflake stage. + properties: + name: + type: string + description: Name of the file. + size: + type: string + description: Size of the file. + readOnly: true + md5: + type: string + description: md5 hash of the file. + readOnly: true + last_modified: + type: string + description: Date and time when the file was last modified. + readOnly: true + Stage: + type: object + description: A Snowflake stage. + properties: + name: + $ref: ./common.yaml#/components/schemas/Identifier + description: String that specifies the identifier (i.e. name) for the stage. + kind: + type: string + enum: + - PERMANENT + - TEMPORARY + default: PERMANENT + description: Specifies whether the stage is permanent or temporary. + url: + type: string + description: URL for the external stage; blank for an internal stage. + endpoint: + type: string + description: The S3-compatible API endpoint associated with the stage; always + NULL for stages that are not S3-compatible. + storage_integration: + $ref: ./common.yaml#/components/schemas/Identifier + description: Storage integration associated with the stage; always NULL + for an internal stage. + comment: + type: string + description: Specifies a comment for the stage. + credentials: + $ref: '#/components/schemas/Credentials' + writeOnly: true + description: Credentials of the stage. + encryption: + type: object + description: Encryption parameters of the stage. + writeOnly: true + properties: + type: + type: string + enum: + - SNOWFLAKE_FULL + - SNOWFLAKE_SSE + - AWS_CSE + - AWS_SSE_S3 + - AWS_SSE_KMS + - GCS_SSE_KMS + - AZURE_CSE + - NONE + description: Specifies the encryption type used. + master_key: + type: string + description: Specifies the client-side master key used to encrypt the + files in the bucket. The master key must be a 128-bit or 256-bit key + in Base64-encoded form. + kms_key_id: + type: string + description: Optionally specifies the ID for the KMS-managed key used + to encrypt files unloaded into the bucket. + directory_table: + type: object + description: Directory table parameters of the stage. + properties: + enable: + type: boolean + default: false + description: Specifies whether to add a directory table to the stage. + When the value is TRUE, a directory table is created with the stage. + refresh_on_create: + type: boolean + default: true + writeOnly: true + description: Specifies whether to automatically refresh the directory + table metadata once, immediately after the stage is created. + auto_refresh: + type: boolean + default: false + writeOnly: true + description: Specifies whether Snowflake should enable triggering automatic + refreshes of the directory table metadata when new or updated data + files are available in the named external stage specified in the URL + value. + notification_integration: + type: string + writeOnly: true + description: Specifies the name of the notification integration used + to automatically refresh the directory table metadata. + created_on: + type: string + description: Date and time when the stage was created. + format: date-time + readOnly: true + has_credentials: + type: boolean + description: Indicates that the external stage has access credentials; always + false for an internal stage. + readOnly: true + has_encryption_key: + type: boolean + description: Indicates that the external stage contains encrypted files; + always false for an internal stage. + readOnly: true + owner: + type: string + description: Role that owns the stage. + readOnly: true + owner_role_type: + type: string + description: The type of role that owns the object, either ROLE or DATABASE_ROLE. + If a Snowflake Native App owns the object, the value is APPLICATION. Snowflake + returns NULL if you delete the object because a deleted object does not + have an owner role. + readOnly: true + region: + type: string + description: Region where the stage is located. + readOnly: true + cloud: + type: string + description: Cloud provider; always NULL for an internal stage. + readOnly: true + example: + name: stage_name + required: + - name + Credentials: + type: object + description: Specifies the credentials of the stage. + properties: + credential_type: + description: Type of the credential, can be either AWS or AZURE. + type: string + discriminator: + propertyName: credential_type + mapping: + AWS: AwsCredentials + AZURE: AzureCredentials + AwsCredentials: + description: Specifies the AWS credentials of the stage. + allOf: + - $ref: '#/components/schemas/Credentials' + properties: + aws_key_id: + type: string + description: Scoped credentials generated by AWS Security Token Service + (STS). + aws_secret_key: + type: string + description: Scoped credentials generated by AWS Security Token Service + (STS). + aws_token: + type: string + description: Scoped credentials generated by AWS Security Token Service + (STS). + aws_role: + type: string + description: Omit the security credentials and access keys and, instead, + identify the role using AWS_ROLE and specify the AWS role ARN (Amazon + Resource Name). + AzureCredentials: + description: Specifies the Azure credentials of the stage. + allOf: + - $ref: '#/components/schemas/Credentials' + properties: + azure_sas_token: + type: string + description: Specifies the SAS (shared access signature) token for connecting + to Azure. +tags: +- name: stage diff --git a/public-preview/8.30/specification/table.yaml b/public-preview/8.30/specification/table.yaml new file mode 100644 index 0000000..5e90469 --- /dev/null +++ b/public-preview/8.30/specification/table.yaml @@ -0,0 +1,1157 @@ +openapi: 3.0.0 +servers: +- description: Snowflake REST Server + url: https://org-account.snowflakecomputing.com +info: + version: 0.0.1 + title: Snowflake Table API + description: The Snowflake Table API is a REST API that you can use to access, update, + and perform certain actions on Tables resource in a Snowflake database. + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/databases/{database}/schemas/{schema}/tables: + get: + summary: List tables + tags: + - table + description: Lists the tables under the database and schema. + operationId: listTables + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/like + - $ref: common.yaml#/components/parameters/startsWith + - $ref: common.yaml#/components/parameters/showLimit + - $ref: common.yaml#/components/parameters/fromName + - name: history + description: Optionally includes dropped tables that have not yet been purged. + in: query + required: false + schema: + type: boolean + - name: deep + description: Optionally includes dependency information of the table. + in: query + required: false + schema: + type: boolean + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Table' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + post: + summary: Create a table (clone and undrop are separate subresources) + tags: + - table + description: Create a table. + operationId: createTable + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/createMode + - $ref: common.yaml#/components/parameters/copyGrants + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/tables/{name}:as_select: + post: + deprecated: true + summary: Create a table using the result of the specified select query + tags: + - table + description: Create a table as select. + operationId: createTableAsSelectDeprecated + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/createMode + - $ref: common.yaml#/components/parameters/copyGrants + - name: query + in: query + required: true + description: The SQL select query to run to set up the table values (and possibly + columns). + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/tables:as-select: + post: + summary: Create a table using the result of the specified select query + tags: + - table + description: Create a table as select. + operationId: createTableAsSelect + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/createMode + - $ref: common.yaml#/components/parameters/copyGrants + - name: query + in: query + required: true + description: The SQL select query to run to set up the table values (and possibly + columns). + schema: + type: string + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TableAsSelect' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/tables/{name}:using_template: + post: + deprecated: true + summary: Create a table using the templates specified in staged files + tags: + - table + description: Create a table using template. + operationId: createTableUsingTemplateDeprecated + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/createMode + - $ref: common.yaml#/components/parameters/copyGrants + - name: query + description: The SQL query that uses INFER_SCHEMA on staged files to set the + column definitions for the new table. + in: query + required: true + schema: + type: string + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/tables:using-template: + post: + summary: Create a table using the templates specified in staged files + tags: + - table + description: Create a table using template. + operationId: createTableUsingTemplate + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/createMode + - $ref: common.yaml#/components/parameters/copyGrants + - name: query + description: The SQL query that uses INFER_SCHEMA on staged files to set the + column definitions for the new table. + in: query + required: true + schema: + type: string + requestBody: + required: false + content: + application/json: + schema: + $ref: '#/components/schemas/TableUsingTemplate' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/tables/{name}: + get: + summary: Fetch a table. + tags: + - table + description: Fetch a Table using the describe command output. + operationId: fetchTable + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + put: + summary: Create a (or alter an existing) table. + tags: + - table + description: Create a (or alter an existing) table. Even if the operation is + just an alter, the full property set must be provided. + operationId: createOrAlterTable + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Table' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + delete: + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/ifExists + summary: Delete a table + tags: + - table + description: Delete a table with the given name. + operationId: deleteTable + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/tables/{name}:clone: + post: + summary: Clone table + tags: + - table + description: Create a new table by cloning from the specified resource + operationId: cloneTable + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/createMode + - $ref: common.yaml#/components/parameters/copyGrants + - name: targetDatabase + in: query + description: Database of the newly created table. Defaults to the source table's + database. + schema: + $ref: ./common.yaml#/components/schemas/Identifier + - name: targetSchema + in: query + description: Schema of the newly created table. Defaults to the source table's + schema. + schema: + $ref: ./common.yaml#/components/schemas/Identifier + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TableClone' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/tables/{name}:create_like: + post: + deprecated: true + summary: Create a table like this existing one + tags: + - table + description: Create a new table like the specified resource, but empty + operationId: createTableLikeDeprecated + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/createMode + - $ref: common.yaml#/components/parameters/copyGrants + - name: newTableName + description: The name of the table to be created. + in: query + required: true + schema: + type: string + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/tables/{name}:create-like: + post: + summary: Create a table like this existing one + tags: + - table + description: Create a new table like the specified resource, but empty + operationId: createTableLike + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/createMode + - $ref: common.yaml#/components/parameters/copyGrants + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TableLike' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/tables/{name}:undrop: + post: + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + summary: Undrop a table + tags: + - table + description: Undrop specified table + operationId: undropTable + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/tables/{name}:suspend_recluster: + post: + deprecated: true + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/ifExists + summary: Suspend recluster of a table + tags: + - table + description: Suspend recluster of a table + operationId: suspendReclusterTableDeprecated + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/tables/{name}:suspend-recluster: + post: + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/ifExists + summary: Suspend recluster of a table + tags: + - table + description: Suspend recluster of a table + operationId: suspendReclusterTable + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/tables/{name}:resume_recluster: + post: + deprecated: true + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/ifExists + summary: Resume recluster of a table + tags: + - table + description: Resume recluster of a table + operationId: resumeReclusterTableDeprecated + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/tables/{name}:resume-recluster: + post: + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/ifExists + summary: Resume recluster of a table + tags: + - table + description: Resume recluster of a table + operationId: resumeReclusterTable + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/tables/{name}:swapwith: + post: + deprecated: true + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/ifExists + - name: targetTableName + description: The fully-specified name of the target table to be swapped with. + in: query + required: true + schema: + type: string + summary: Swap with another table + tags: + - table + description: Swap with another table + operationId: swapWithTableDeprecated + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/tables/{name}:swap-with: + post: + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/ifExists + - name: targetName + description: The fully-specified name of the target table to be swapped with. + in: query + required: true + schema: + type: string + summary: Swap with another table + tags: + - table + description: Swap with another table + operationId: swapWithTable + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +components: + schemas: + Table: + type: object + description: A Snowflake table + properties: + name: + type: string + description: Specifies the name for the table, must be unique for the schema + in which the table is created + kind: + type: string + enum: + - PERMANENT + - TRANSIENT + - TEMPORARY + - '' + - transient + - temporary + x-enum-varnames: + - PERMANENT + - TRANSIENT + - TEMPORARY + - DEPRECATED_PERMANENT + - DEPRECATED_TRANSIENT + - DEPRECATED_TEMPORARY + default: PERMANENT + description: Table type - permanent, transient, or temporary + cluster_by: + type: array + description: Specifies one or more columns or column expressions in the + table as the clustering key + items: + type: string + enable_schema_evolution: + type: boolean + description: Table has schema evolution enabled or disabled + change_tracking: + type: boolean + description: Change tracking is enabled or disabled + data_retention_time_in_days: + type: integer + description: Specifies the retention period for the table so that Time Travel + actions SELECT, CLONE, UNDROP can be performed on historical data in the + table + max_data_extension_time_in_days: + type: integer + description: Specifies the retention period for the table so that Time Travel + actions SELECT, CLONE, UNDROP can be performed on historical data in the + table + default_ddl_collation: + type: string + description: Specifies a default collation specification for the columns + in the table, including columns added to the table in the future + columns: + type: array + items: + $ref: '#/components/schemas/TableColumn' + constraints: + type: array + items: + $ref: '#/components/schemas/Constraint' + comment: + type: string + description: Comment for the table + created_on: + type: string + format: date-time + readOnly: true + description: Date and time when the table was created. + database_name: + type: string + readOnly: true + description: Database in which the table is stored + schema_name: + type: string + readOnly: true + description: Schema in which the table is stored + rows: + type: integer + format: int64 + readOnly: true + description: Number of rows in the table. Returns NULL for external tables. + bytes: + type: integer + format: int64 + readOnly: true + description: Number of bytes that will be scanned if the entire table is + scanned in a query. Note that this number may be different than the number + of actual physical bytes stored on-disk for the table + owner: + type: string + readOnly: true + description: Role that owns the table + dropped_on: + type: string + format: date-time + readOnly: true + description: Date and time when the table was dropped + automatic_clustering: + type: boolean + readOnly: true + description: If Automatic Clustering is enabled for your account, specifies + whether it is explicitly enabled or disabled for the table. + search_optimization: + type: boolean + readOnly: true + description: If ON, the table has the search optimization service enabled + search_optimization_progress: + type: integer + format: int64 + readOnly: true + description: Percentage of the table that has been optimized for search. + search_optimization_bytes: + type: integer + format: int64 + readOnly: true + description: Number of additional bytes of storage that the search optimization + service consumes for this table + owner_role_type: + type: string + readOnly: true + description: The type of role that owns the object. + budget: + type: string + readOnly: true + description: Name of the budget if the object is monitored by a budget + required: + - name + TableColumn: + type: object + description: A column in the table + properties: + name: + type: string + description: Column name + datatype: + type: string + description: The data type for the column + nullable: + type: boolean + default: true + description: Specifies that the column does allow NULL values or not. + collate: + type: string + description: Specifies the collation to use for column operations such as + string comparison + default: + type: string + description: Specifies whether a default value is automatically inserted + in the column if a value is not explicitly specified via an INSERT or + CREATE TABLE AS SELECT statement + autoincrement: + type: boolean + autoincrement_start: + type: integer + description: The default value for the column starts with the specified + number + autoincrement_increment: + type: integer + description: Each successive value for the column automatically increments + by the specified amount + constraints: + type: array + items: + $ref: '#/components/schemas/Constraint' + comment: + type: string + description: Specifies a comment for the column + required: + - name + - datatype + Constraint: + type: object + description: Constraints define integrity and consistency rules for data stored + in tables. + properties: + name: + type: string + description: Name of the Constraint + column_names: + type: array + items: + type: string + description: Column name for the constraint + constraint_type: + type: string + description: Type of the constraint + discriminator: + propertyName: constraint_type + mapping: + PRIMARY KEY: PrimaryKey + FOREIGN KEY: ForeignKey + UNIQUE: UniqueKey + PrimaryKey: + allOf: + - $ref: '#/components/schemas/Constraint' + type: object + description: A primary key is the column or columns that contain values that + uniquely identify each row in a table. + UniqueKey: + allOf: + - $ref: '#/components/schemas/Constraint' + type: object + description: Unique keys are columns in a table that uniquely identify items + in the rows. This sounds a lot like a primary key, but the main difference + is that unique keys can have NULL values. + ForeignKey: + allOf: + - $ref: '#/components/schemas/Constraint' + type: object + description: Foreign keys link data in one table to the data in another table. + properties: + referenced_table_name: + type: string + referenced_column_names: + type: array + items: + type: string + required: + - referenced_table_name + - referenced_column_names + TableClone: + type: object + description: Clone table + allOf: + - $ref: '#/components/schemas/Table' + properties: + point_of_time: + $ref: common.yaml#/components/schemas/PointOfTime + TableAsSelect: + type: object + description: Create table as select + properties: + name: + type: string + description: Specifies the name for the table, must be unique for the schema + in which the table is created + columns: + type: array + items: + $ref: '#/components/schemas/TableColumn' + cluster_by: + type: array + description: Specifies one or more columns or column expressions in the + table as the clustering key + items: + type: string + TableUsingTemplate: + type: object + description: Create table using template + properties: + name: + type: string + description: Specifies the name for the table, must be unique for the schema + in which the table is created + TableLike: + type: object + description: Create table like an existing table + properties: + name: + type: string + description: Specifies the name for the table, must be unique for the schema + in which the table is created +tags: +- name: table diff --git a/public-preview/8.30/specification/task.yaml b/public-preview/8.30/specification/task.yaml new file mode 100644 index 0000000..aa6e981 --- /dev/null +++ b/public-preview/8.30/specification/task.yaml @@ -0,0 +1,900 @@ +openapi: 3.0.0 +servers: +- description: Snowflake Task API + url: https://org-account.snowflakecomputing.com +info: + version: 0.0.1 + title: Snowflake Task API + description: The Snowflake Task API is a REST API that you can use to access, update, + and perform certain actions on task resources in a Snowflake database. + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/databases/{database}/schemas/{schema}/tasks: + get: + summary: List tasks + tags: + - task + description: Lists tasks under the database and schema, with show options as + query parameters. + operationId: listTasks + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/rootOnly + - $ref: common.yaml#/components/parameters/like + - $ref: common.yaml#/components/parameters/startsWith + - $ref: common.yaml#/components/parameters/showLimit + - $ref: common.yaml#/components/parameters/fromName + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Task' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + post: + summary: Create a task + tags: + - task + description: Create a task, with standard create modifiers as query parameters. + See the Task component definition for what is required to be provided in the + request body. + operationId: createTask + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/createMode + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Task' + example: + name: name_example + warehouse: REGRESS + schedule: + schedule_type: MINUTES_TYPE + minutes: 10 + predecessors: + - task1 + - task2 + - task3 + comment: test_comment + definition: select 1 + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/tasks/{name}: + get: + summary: Fetch a task + tags: + - task + description: Fetch a task using the describe command output. + operationId: fetchTask + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + $ref: '#/components/schemas/Task' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + put: + summary: Create a (or alter an existing) task + tags: + - task + description: Create a (or alter an existing) task. Even if the operation is + just an alter, the full property set must be provided. + operationId: createOrAlterTask + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Task' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + delete: + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/ifExists + summary: Delete a task + tags: + - task + description: Delete a task with the task 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. + operationId: deleteTask + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/tasks/{name}:execute: + post: + summary: Execute a task object. + tags: + - task + description: Execute a task -- this is equivalent to EXECUTE IMMEDIATE. + operationId: executeTask + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - name: retryLast + in: query + description: Retry the last failed run of the DAG. + schema: + type: boolean + default: false + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/tasks/{name}:resume: + post: + summary: Resume a suspended task. + tags: + - task + description: Resumes a suspended task object. This is equivalento an ALTER TASK + ... RESUME. + operationId: resumeTask + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/tasks/{name}:suspend: + post: + summary: Suspends a running task. + tags: + - task + description: Suspends a running task. This is equivalent to an ALTER TASK ... + SUSPEND. + operationId: suspendTask + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/tasks/{name}/dependents: + get: + summary: Fetch the dependent tasks of a task + tags: + - task + description: This operation returns a list of the dependent tasks of the task + with identifier {name}. + operationId: fetchTaskDependents + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - name: recursive + in: query + description: Specifies whether to limit the output to include only direct + child tasks or to include all recursive child tasks. + schema: + type: boolean + default: true + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Task' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/tasks/{name}/current_graphs: + get: + deprecated: true + summary: Get the graph runs that are executing or scheduled for the task for + the next 8 days. + tags: + - task + description: This function returns details for graph runs that are currently + executing or are next scheduled to run within the next 8 days. + operationId: getCurrentGraphsDeprecated + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - in: query + name: resultLimit + schema: + type: integer + description: Number of results to return, at most. Default is 1000, valid + range is 1 to 10000. + responses: + '200': + description: successful + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TaskRun' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/tasks/{name}/current-graphs: + get: + summary: Get the graph runs that are executing or scheduled for the task for + the next 8 days. + tags: + - task + description: This function returns details for graph runs that are currently + executing or are next scheduled to run within the next 8 days. + operationId: getCurrentGraphs + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - in: query + name: resultLimit + schema: + type: integer + description: Number of results to return, at most. Default is 1000, valid + range is 1 to 10000. + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TaskRun' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/tasks/{name}/complete_graphs: + get: + deprecated: true + summary: Get the graph runs that are completed for the task. + tags: + - task + description: This function returns details for graph runs that are completed. + operationId: getCompleteGraphsDeprecated + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - in: query + name: resultLimit + schema: + type: integer + description: Number of results to return, at most. Default is 1000, valid + range is 1 to 10000. + - in: query + name: errorOnly + schema: + type: boolean + description: Whether to only return results for tasks runs that have failed. + Default is false. + responses: + '200': + description: successful + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TaskRun' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/tasks/{name}/complete-graphs: + get: + summary: Get the graph runs that are completed for the task. + tags: + - task + description: This function returns details for graph runs that are completed. + operationId: getCompleteGraphs + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - in: query + name: resultLimit + schema: + type: integer + description: Number of results to return, at most. Default is 1000, valid + range is 1 to 10000. + - in: query + name: errorOnly + schema: + type: boolean + description: Whether to only return results for tasks runs that have failed. + Default is false. + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TaskRun' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +components: + schemas: + TaskRun: + type: object + description: A task run executing a standalone task or a DAG of tasks starting + from the root task. + properties: + root_task_name: + type: string + description: The name of the root task in the current task run. + readOnly: true + database_name: + type: string + description: The name of the current database for the task run. + readOnly: true + schema_name: + type: string + description: The name of the current schema for the task run. + readOnly: true + state: + type: string + description: The current state of the task run. + enum: + - SCHEDULED + - EXECUTING + - SUCCEEDED + - FAILED + - CANCELLED + - SKIPPED + readOnly: true + first_error_task_name: + type: string + description: The name of the first task throwing an error in the task run. + readOnly: true + first_error_code: + type: integer + description: The first error code thrown in the task run. + readOnly: true + first_error_message: + type: string + description: The first error message thrown in the task run. + readOnly: true + scheduled_time: + type: string + description: The scheduled time for the task run. + format: date-time + readOnly: true + query_start_time: + type: string + description: The start time for the task run query. + format: date-time + readOnly: true + next_scheduled_time: + type: string + description: The next upcoming time for the task run. + format: date-time + readOnly: true + completed_time: + type: string + description: The time this task run was last completed. + format: date-time + readOnly: true + root_task_id: + type: string + description: The unique task ID for the root task. + readOnly: true + graph_version: + type: integer + description: The current version of the DAG on the task run. + readOnly: true + run_id: + type: integer + description: The unique ID for the current task run. + readOnly: true + example: + root_task_name: root_task + database_name: test_db + schema_name: test_schema + state: SCHEDULED + first_error_task_name: test_task + first_error_code: 0 + first_error_message: ERROR + scheduled_time: '2024-06-18T01:01:01.111111' + query_start_time: '2024-06-18T01:01:01.111111' + next_scheduled_time: '2024-06-18T01:01:01.111111' + completed_time: '2024-06-18T01:01:01.111111' + root_task_id: '0' + graph_version: 0 + run_id: 0 + required: + - root_task_name + - database_name + - schema_name + - state + - scheduled_time + - next_scheduled_time + - root_task_id + - graph_version + - run_id + Task: + type: object + description: A Snowflake task, used to execute SQL code. + properties: + name: + $ref: ./common.yaml#/components/schemas/Identifier + description: String that specifies the identifier (i.e. name) for the task. + warehouse: + $ref: ./common.yaml#/components/schemas/Identifier + description: Specifies the virtual warehouse that provides compute resources + for task runs. + schedule: + $ref: '#/components/schemas/TaskSchedule' + description: Specifies the schedule for periodically running the task. + comment: + type: string + description: Specifies a comment for the task. + finalize: + type: string + description: Specifies the name of the root task that the finalizer task + is associated with. + task_auto_retry_attempts: + type: integer + description: Root task settable only. Specifies the number of automatic + task graph retry attempts. Valid range is 0 to 30. When not specified, + no retry would happen. + minimum: 0 + maximum: 30 + config: + type: object + additionalProperties: true + description: Task Config + session_parameters: + type: object + additionalProperties: true + description: Session Parameters for the task at runtime. + definition: + type: string + description: The SQL definition for the task. Any one of single SQL statement, + call to stored procedure, or procedural logic using Snowflake scripting. + predecessors: + type: array + description: Specifies one or more predecessor tasks for the current task + items: + type: string + description: The identifier for the task. + task_relations: + type: string + description: Displays the relationship between the root task and its corresponding + finalizer tasks. + readOnly: true + user_task_managed_initial_warehouse_size: + type: string + description: Specifies the size of the compute resources to provision for + the first run of the task + user_task_timeout_ms: + type: integer + description: Specifies the time limit on a single run of the task before + it times out (in milliseconds). + suspend_task_after_num_failures: + type: integer + description: Specifies the number of consecutive failed task runs after + which the current task is suspended automatically. + condition: + type: string + description: Specifies a Boolean SQL expression condition; multiple conditions + joined with AND/OR are supported + allow_overlapping_execution: + type: boolean + description: Specifies whether to allow multiple instances of the DAG to + run concurrently. + error_integration: + type: string + description: Specifies the name of the notification integration used to + communicate with Amazon SNS, MS Azure Event Grid, or Google Pub/Sub. + created_on: + type: string + description: The time the task was created on. + format: date-time + readOnly: true + id: + type: string + description: An ID for the current task. + readOnly: true + owner: + type: string + description: The role that owns the task. + readOnly: true + owner_role_type: + type: string + description: The role type of the task owner. + readOnly: true + state: + type: string + description: The state of the task. Must be one of started or suspended. + readOnly: true + enum: + - started + - suspended + last_committed_on: + type: string + description: The time the task was last committed on. + readOnly: true + format: date-time + last_suspended_on: + type: string + description: The time the task was last suspended on. + readOnly: true + format: date-time + database_name: + type: string + description: The name of the parent database for the task. + readOnly: true + schema_name: + type: string + description: The name of the parent schema for the task. + readOnly: true + example: + name: name_example + warehouse: test_wh + schedule: + schedule_type: MINUTES_TYPE + minutes: 10 + comment: test_comment + config: + output_dir: /temp/test_directory/ + learning_rate: '0.1' + definition: this task does... + predecessors: + - task1 + - task2 + - task3 + user_task_managed_initial_warehouse_size: XSMALL + user_task_timeout_ms: 10 + suspend_task_after_num_failures: 3 + condition: select 1 + allow_overlapping_execution: false + error_integration: my_notification_int + created_on: '2024-06-18T01:01:01.111111' + id: task_id + owner: TASK_ADMIN + owner_role_type: ADMIN + state: started + last_committed_on: '2024-06-18T01:01:01.111111' + last_suspended_on: '2024-06-18T01:01:01.111111' + database_name: TESTDB + schema_name: TESTSCHEMA + required: + - name + - definition + TaskSchedule: + type: object + description: Specifies the schedule for periodically running the task. + properties: + schedule_type: + description: Type of the schedule, can be either CRON_TYPE or MINUTES_TYPE. + type: string + discriminator: + propertyName: schedule_type + mapping: + CRON_TYPE: CronSchedule + MINUTES_TYPE: MinutesSchedule + CronSchedule: + description: A cron schedule for executing a task at a specified interval. + allOf: + - $ref: '#/components/schemas/TaskSchedule' + properties: + cron_expr: + type: string + description: A cron expression for the task execution. + timezone: + type: string + description: The time zone for the schedule. + example: + cron_expr: '* * * * ? *' + timezone: america/los_angeles + required: + - cron_expr + - timezone + MinutesSchedule: + description: A schedule for executing a task at specified intervals of minutes. + allOf: + - $ref: '#/components/schemas/TaskSchedule' + properties: + minutes: + type: integer + description: The number of minutes between each task run. + example: + minutes: 10 + required: + - minutes +externalDocs: + description: Streams and Tasks Reference + url: https://docs.snowflake.com/en/sql-reference/commands-stream +tags: +- name: task diff --git a/public-preview/8.30/specification/user.yaml b/public-preview/8.30/specification/user.yaml new file mode 100644 index 0000000..0422d9c --- /dev/null +++ b/public-preview/8.30/specification/user.yaml @@ -0,0 +1,325 @@ +openapi: 3.0.0 +servers: +- description: Snowflake REST Server + url: https://org-account.snowflakecomputing.com +info: + version: 0.0.1 + title: Snowflake User API + description: The Snowflake User API is a REST API that you can use to access, update, + and perform certain action on Users in a Snowflake database. + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/users: + post: + summary: Create a user + tags: + - user + description: Create a user according to the parameters given + operationId: createUser + parameters: + - $ref: common.yaml#/components/parameters/createMode + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/User' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + get: + summary: List users in the system. + tags: + - user + description: Lists the users in the system. + operationId: listUsers + parameters: + - $ref: common.yaml#/components/parameters/like + - $ref: common.yaml#/components/parameters/startsWith + - $ref: common.yaml#/components/parameters/showLimit + - $ref: common.yaml#/components/parameters/fromName + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/User' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/users/{name}: + get: + parameters: + - $ref: common.yaml#/components/parameters/name + summary: Fetch information about a user + tags: + - user + description: Fetch user information using the result of the DESCRIBE command + operationId: fetchUser + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + $ref: '#/components/schemas/User' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + delete: + parameters: + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/ifExists + summary: Delete a user + tags: + - user + description: Delete a user with the given name. + operationId: deleteUser + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +components: + schemas: + User: + description: Properties of user. + type: object + required: + - name + properties: + name: + type: string + description: User name + example: jackpatel + password: + type: string + description: Password + login_name: + type: string + description: Login name + display_name: + type: string + description: Display name + first_name: + type: string + description: First name + middle_name: + type: string + description: Middle name + last_name: + type: string + description: Last name + email: + type: string + description: Email address + must_change_password: + type: boolean + description: Does this user need to change their password (e.g., after assigning + a temp password) + disabled: + type: boolean + description: Has this user been disabled from the system + days_to_expiry: + type: integer + description: How many days until this user expires + mins_to_unlock: + type: integer + description: How many minutes until the account is unlocked after multiple + failed logins + default_warehouse: + type: string + description: The default warehouse to use when this user starts a session + default_namespace: + type: string + description: The default namespace to use when this user starts a session + default_role: + type: string + description: The default role to use when this user starts a session + default_secondary_roles: + type: string + description: The default secondary roles of this user to use when starting + a session. Only valid set value is ALL. + mins_to_bypass_mfa: + type: integer + description: How many minutes until MFA is required again + rsa_public_key: + type: string + description: RSA public key of the user + rsa_public_key_fp: + type: string + description: Fingerprint of the user's RSA public key + rsa_public_key_2: + type: string + description: Second RSA public key of the user + rsa_public_key_2_fp: + type: string + description: Fingerprint of the user's second RSA public key + comment: + type: string + description: Comment about the user. + example: A distinguished user + type: + type: string + description: Indicates the type of user (REGULAR or SERVICE) + created_on: + type: string + readOnly: true + format: date-time + last_successful_login: + type: string + readOnly: true + format: date-time + expires_at: + type: string + readOnly: true + format: date-time + locked_until: + type: string + readOnly: true + format: date-time + has_password: + type: boolean + readOnly: true + has_rsa_public_key: + type: boolean + readOnly: true + ext_authn_duo: + type: boolean + readOnly: true + ext_authn_uid: + type: string + readOnly: true + owner: + type: string + readOnly: true + snowflake_lock: + type: boolean + readOnly: true + default: false + description: Whether the user, account, or organization is locked by Snowflake. + snowflake_support: + type: boolean + readOnly: true + default: false + description: Whether Snowflake Support is allowed to use the user or account + mins_to_bypass_network_policy: + type: integer + readOnly: true + description: Temporary bypass network policy on the user for a specified + number of minutes + password_last_set: + type: string + readOnly: true + format: date-time + custom_landing_page_url: + type: string + readOnly: true + custom_landing_page_url_flush_next_ui_load: + type: boolean + readOnly: true + default: false + description: Whether or not to flush the custom landing page of the user + on next UI load +tags: +- name: user diff --git a/public-preview/8.30/specification/warehouse.yaml b/public-preview/8.30/specification/warehouse.yaml new file mode 100644 index 0000000..ca38824 --- /dev/null +++ b/public-preview/8.30/specification/warehouse.yaml @@ -0,0 +1,610 @@ +openapi: 3.0.0 +servers: +- description: Snowflake Warehouse API + url: https://org-account.snowflakecomputing.com +info: + version: 0.0.1 + title: Snowflake Warehouse API + description: The Snowflake Warehouse API is a REST API that you can use to access, + customize and manage virtual warehouse in a Snowflake account. + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/warehouses: + post: + summary: Create or replace warehouse + description: Create a virtual warehouse. Equivalent to CREATE WAREHOUSE in SQL. + operationId: createWarehouse + tags: + - warehouse + parameters: + - $ref: common.yaml#/components/parameters/createMode + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Warehouse' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + get: + summary: List warehouse + description: Show a list of warehouse filtered by pattern. Equivalent to SHOW + WAREHOUSE in SQL. + operationId: listWarehouses + tags: + - warehouse + parameters: + - $ref: common.yaml#/components/parameters/like + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Warehouse' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/warehouses/{name}: + get: + summary: Describe warehouse + description: Describes the warehouse, show information of the chosen warehouse. + Equivalent to DESCRIBE WAREHOUSE in SQL. + operationId: fetchWarehouse + tags: + - warehouse + parameters: + - $ref: common.yaml#/components/parameters/name + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + content: + application/json: + schema: + $ref: '#/components/schemas/Warehouse' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + delete: + summary: Drop warehouse + description: Removes the specified virtual warehouse from the system. Equivalent + to DROP WAREHOUSE in SQL. + operationId: deleteWarehouse + tags: + - warehouse + parameters: + - $ref: common.yaml#/components/parameters/ifExists + - $ref: common.yaml#/components/parameters/name + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + put: + summary: Create a (or alter an existing) warehouse. + description: Create a (or alter an existing) warehouse. Even if the operation + is just an alter, the full property set must be provided. + operationId: createOrAlterWarehouse + tags: + - warehouse + parameters: + - $ref: common.yaml#/components/parameters/name + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Warehouse' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/warehouses/{name}:resume: + post: + summary: resume warehouse + description: "Bring current warehouse to a usable \u2018Running\u2019 state\ + \ by provisioning compute resources if current warehouse is suspended." + operationId: resumeWarehouse + tags: + - warehouse + parameters: + - $ref: common.yaml#/components/parameters/ifExists + - $ref: common.yaml#/components/parameters/name + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/warehouses/{name}:suspend: + post: + summary: suspend warehouse + description: "Remove all compute nodes from a warehouse and put the warehouse\ + \ into a \u2018Suspended\u2019 state if current warehouse is not suspended." + operationId: suspendWarehouse + tags: + - warehouse + parameters: + - $ref: common.yaml#/components/parameters/ifExists + - $ref: common.yaml#/components/parameters/name + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/warehouses/{name}:rename: + post: + summary: update and rename warehouse + description: Specifies a new identifier for the warehouse; must be unique for + current account. + operationId: renameWarehouse + tags: + - warehouse + parameters: + - $ref: common.yaml#/components/parameters/ifExists + - $ref: common.yaml#/components/parameters/name + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Warehouse' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/warehouses/{name}:abort: + post: + summary: abort all queries + description: Aborts all the queries currently running or queued on the warehouse. + operationId: abortAllQueriesOnWarehouse + tags: + - warehouse + parameters: + - $ref: common.yaml#/components/parameters/ifExists + - $ref: common.yaml#/components/parameters/name + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/warehouses/{name}:use: + post: + summary: use current warehouse for session + description: '[Deprecated] Specifies the active/current warehouse for the session.' + operationId: useWarehouse + tags: + - warehouse + deprecated: true + parameters: + - $ref: common.yaml#/components/parameters/name + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +components: + schemas: + Warehouse: + type: object + description: A Snowflake virtual warehouse + properties: + name: + $ref: ./common.yaml#/components/schemas/Identifier + description: Name of warehouse + warehouse_type: + type: string + description: 'Type of warehouse, possible types: STANDARD, SNOWPARK-OPTIMIZED' + warehouse_size: + type: string + description: 'Size of warehouse, possible sizes: XSMALL, SMALL, MEDIUM, + LARGE, XLARGE, XXLARGE, XXXLARGE, X4LARGE, X5LARGE, X6LARGE' + wait_for_completion: + type: string + enum: + - true + - false + description: When resizing a warehouse, you can use this parameter to block + the return of the ALTER WAREHOUSE command until the resize has finished + provisioning all its compute resources + max_cluster_count: + type: integer + format: int32 + description: Specifies the maximum number of clusters for a multi-cluster + warehouse + min_cluster_count: + type: integer + format: int32 + description: Specifies the minimum number of clusters for a multi-cluster + warehouse + scaling_policy: + type: string + description: 'Scaling policy of warehouse, possible scaling policies: STANDARD, + ECONOMY' + auto_suspend: + type: integer + format: int32 + description: time in seconds before auto suspend + auto_resume: + type: string + enum: + - true + - false + description: Specifies whether to automatically resume a warehouse when + a SQL statement is submitted to it + initially_suspended: + type: string + enum: + - true + - false + description: Specifies whether the warehouse is created initially in the + Suspended state + resource_monitor: + $ref: ./common.yaml#/components/schemas/Identifier + description: Specifies the name of a resource monitor that is explicitly + assigned to the warehouse. When a resource monitor is explicitly assigned + to a warehouse, the monitor controls the monthly credits used by the warehouse + comment: + type: string + format: comment + description: Specifies a comment for the warehouse + enable_query_acceleration: + type: string + enum: + - true + - false + description: Specifies whether to enable the query acceleration service + for queries that rely on this warehouse for compute resources + query_acceleration_max_scale_factor: + type: integer + format: int32 + description: Specifies the maximum scale factor for leasing compute resources + for query acceleration. The scale factor is used as a multiplier based + on warehouse size + max_concurrency_level: + type: integer + format: int32 + description: Object parameter that specifies the concurrency level for SQL + statements executed by a warehouse cluster + statement_queued_timeout_in_seconds: + type: integer + format: int32 + description: Object parameter that specifies the time, in seconds, a SQL + statement can be queued on a warehouse before it is canceled by the system + statement_timeout_in_seconds: + type: integer + format: int32 + description: Object parameter that specifies the time, in seconds, after + which a running SQL statement is canceled by the system + type: + type: string + description: '[Deprecated] Type of warehouse, possible types: STANDARD, + SNOWPARK-OPTIMIZED' + deprecated: true + size: + type: string + description: '[Deprecated] names of size: X-Small, Small, Medium, Large, + X-Large, 2X-Large, 3X-Large, 4X-Large, 5X-Large, 6X-Large' + deprecated: true + state: + type: string + readOnly: true + description: 'The state of warehouse, possible states: STARTED, STARTING, + DYNAMIC, SUSPENDED, RESIZING, RESUMING, SUSPENDING' + started_clusters: + type: integer + format: int32 + readOnly: true + description: Number of clusters currently started. + running: + type: integer + format: int32 + readOnly: true + description: Number of SQL statements that are being executed by the warehouse. + queued: + type: integer + format: int32 + readOnly: true + description: Number of SQL statements that are queued for the warehouse. + is_default: + type: boolean + readOnly: true + description: Whether the warehouse is the default for the current user. + is_current: + type: boolean + readOnly: true + description: Whether the warehouse is in use for the session. Only one warehouse + can be in use at a time for a session. To specify or change the warehouse + for a session, use the USE WAREHOUSE command. + available: + type: string + format: Percentage + readOnly: true + description: Percentage of the warehouse compute resources that are provisioned + and available. + provisioning: + type: string + format: Percentage + readOnly: true + description: Percentage of the warehouse compute resources that are in the + process of provisioning. + quiescing: + type: string + format: Percentage + readOnly: true + description: Percentage of the warehouse compute resources that are executing + SQL statements, but will be shut down once the queries complete. + other: + type: string + format: Percentage + readOnly: true + description: Percentage of the warehouse compute resources that are in a + state other than available, provisioning, or quiescing. + created_on: + type: string + format: date-time + readOnly: true + description: Date and time when the warehouse was created. + resumed_on: + type: string + format: date-time + readOnly: true + description: Date and time when the warehouse was last started or restarted. + updated_on: + type: string + format: date-time + readOnly: true + description: Date and time when the warehouse was last updated, which includes + changing any of the properties of the warehouse or changing the state + (STARTED, SUSPENDED, RESIZING) of the warehouse. + owner: + type: string + format: role name + readOnly: true + description: Role that owns the warehouse. + budget: + type: string + readOnly: true + description: Comment representing budget for warehouse. + kind: + type: string + format: warehouse + readOnly: true + deprecated: true + owner_role_type: + type: string + readOnly: true + description: The type of role that owns the object. + required: + - name