From 6713864cfedfc70bbf8793a1ce2c46904fb54a71 Mon Sep 17 00:00:00 2001 From: Zihan Li Date: Tue, 22 Oct 2024 16:40:14 -0700 Subject: [PATCH] Release GA --- ...Cortex Analyst API.postman_collection.json | 716 + ...rtex Inference API.postman_collection.json | 638 + ...ex Search REST API.postman_collection.json | 934 + ...wflake Account API.postman_collection.json | 3576 +++ ...nowflake Alert API.postman_collection.json | 6706 +++++ ...og Integration API.postman_collection.json | 3234 +++ ... Compute Pools API.postman_collection.json | 6163 +++++ ...flake Database API.postman_collection.json | 14550 ++++++++++ ... Database Role API.postman_collection.json | 10889 ++++++++ ... Dynamic Table API.postman_collection.json | 13103 +++++++++ ...ke Event Table API.postman_collection.json | 5600 ++++ ...xternal Volume API.postman_collection.json | 4256 +++ ...flake Function API.postman_collection.json | 4447 ++++ ...nowflake Grant API.postman_collection.json | 6064 +++++ ...age Repository API.postman_collection.json | 4465 ++++ ...Network Policy API.postman_collection.json | 3129 +++ ...flake Notebook API.postman_collection.json | 8844 ++++++ ...on Integration API.postman_collection.json | 3540 +++ ...Snowflake Pipe API.postman_collection.json | 5375 ++++ ...lake Procedure API.postman_collection.json | 5429 ++++ ...owflake Result API.postman_collection.json | 824 + ...Snowflake Role API.postman_collection.json | 10897 ++++++++ ...owflake Schema API.postman_collection.json | 7651 ++++++ ...flake Services API.postman_collection.json | 13755 ++++++++++ ...nowflake Stage API.postman_collection.json | 5499 ++++ ...owflake Stream API.postman_collection.json | 5600 ++++ ...nowflake Table API.postman_collection.json | 22117 ++++++++++++++++ ...Snowflake Task API.postman_collection.json | 11570 ++++++++ ...Snowflake User API.postman_collection.json | 7699 ++++++ ...fined Function API.postman_collection.json | 5541 ++++ ...Snowflake View API.postman_collection.json | 4595 ++++ ...lake Warehouse API.postman_collection.json | 8660 ++++++ releases/8.40/specifications/account.yaml | 423 + releases/8.40/specifications/alert.yaml | 484 + .../specifications/catalog-integration.yaml | 346 + releases/8.40/specifications/common.yaml | 587 + .../8.40/specifications/compute-pool.yaml | 498 + .../8.40/specifications/cortex-analyst.yaml | 266 + .../8.40/specifications/cortex-inference.yaml | 139 + .../specifications/cortex-search-service.yaml | 115 + .../8.40/specifications/database-role.yaml | 616 + releases/8.40/specifications/database.yaml | 872 + .../8.40/specifications/dynamic-table.yaml | 770 + releases/8.40/specifications/event-table.yaml | 385 + .../8.40/specifications/external-volume.yaml | 400 + releases/8.40/specifications/function.yaml | 345 + releases/8.40/specifications/grant.yaml | 513 + .../8.40/specifications/image-repository.yaml | 310 + .../8.40/specifications/network-policy.yaml | 237 + releases/8.40/specifications/notebook.yaml | 566 + .../notification-integration.yaml | 399 + releases/8.40/specifications/pipe.yaml | 337 + releases/8.40/specifications/procedure.yaml | 815 + releases/8.40/specifications/result.yaml | 82 + releases/8.40/specifications/role.yaml | 721 + releases/8.40/specifications/schema.yaml | 513 + releases/8.40/specifications/service.yaml | 1165 + releases/8.40/specifications/stage.yaml | 514 + releases/8.40/specifications/stream.yaml | 495 + releases/8.40/specifications/table.yaml | 1231 + releases/8.40/specifications/task.yaml | 934 + .../specifications/user-defined-function.yaml | 766 + releases/8.40/specifications/user.yaml | 603 + releases/8.40/specifications/view.yaml | 290 + releases/8.40/specifications/warehouse.yaml | 645 + 65 files changed, 233448 insertions(+) create mode 100644 releases/8.40/collections/Cortex Analyst API.postman_collection.json create mode 100644 releases/8.40/collections/Cortex Inference API.postman_collection.json create mode 100644 releases/8.40/collections/Cortex Search REST API.postman_collection.json create mode 100644 releases/8.40/collections/Snowflake Account API.postman_collection.json create mode 100644 releases/8.40/collections/Snowflake Alert API.postman_collection.json create mode 100644 releases/8.40/collections/Snowflake Catalog Integration API.postman_collection.json create mode 100644 releases/8.40/collections/Snowflake Compute Pools API.postman_collection.json create mode 100644 releases/8.40/collections/Snowflake Database API.postman_collection.json create mode 100644 releases/8.40/collections/Snowflake Database Role API.postman_collection.json create mode 100644 releases/8.40/collections/Snowflake Dynamic Table API.postman_collection.json create mode 100644 releases/8.40/collections/Snowflake Event Table API.postman_collection.json create mode 100644 releases/8.40/collections/Snowflake External Volume API.postman_collection.json create mode 100644 releases/8.40/collections/Snowflake Function API.postman_collection.json create mode 100644 releases/8.40/collections/Snowflake Grant API.postman_collection.json create mode 100644 releases/8.40/collections/Snowflake Image Repository API.postman_collection.json create mode 100644 releases/8.40/collections/Snowflake Network Policy API.postman_collection.json create mode 100644 releases/8.40/collections/Snowflake Notebook API.postman_collection.json create mode 100644 releases/8.40/collections/Snowflake Notification Integration API.postman_collection.json create mode 100644 releases/8.40/collections/Snowflake Pipe API.postman_collection.json create mode 100644 releases/8.40/collections/Snowflake Procedure API.postman_collection.json create mode 100644 releases/8.40/collections/Snowflake Result API.postman_collection.json create mode 100644 releases/8.40/collections/Snowflake Role API.postman_collection.json create mode 100644 releases/8.40/collections/Snowflake Schema API.postman_collection.json create mode 100644 releases/8.40/collections/Snowflake Services API.postman_collection.json create mode 100644 releases/8.40/collections/Snowflake Stage API.postman_collection.json create mode 100644 releases/8.40/collections/Snowflake Stream API.postman_collection.json create mode 100644 releases/8.40/collections/Snowflake Table API.postman_collection.json create mode 100644 releases/8.40/collections/Snowflake Task API.postman_collection.json create mode 100644 releases/8.40/collections/Snowflake User API.postman_collection.json create mode 100644 releases/8.40/collections/Snowflake User Defined Function API.postman_collection.json create mode 100644 releases/8.40/collections/Snowflake View API.postman_collection.json create mode 100644 releases/8.40/collections/Snowflake Warehouse API.postman_collection.json create mode 100644 releases/8.40/specifications/account.yaml create mode 100644 releases/8.40/specifications/alert.yaml create mode 100644 releases/8.40/specifications/catalog-integration.yaml create mode 100644 releases/8.40/specifications/common.yaml create mode 100644 releases/8.40/specifications/compute-pool.yaml create mode 100644 releases/8.40/specifications/cortex-analyst.yaml create mode 100644 releases/8.40/specifications/cortex-inference.yaml create mode 100644 releases/8.40/specifications/cortex-search-service.yaml create mode 100644 releases/8.40/specifications/database-role.yaml create mode 100644 releases/8.40/specifications/database.yaml create mode 100644 releases/8.40/specifications/dynamic-table.yaml create mode 100644 releases/8.40/specifications/event-table.yaml create mode 100644 releases/8.40/specifications/external-volume.yaml create mode 100644 releases/8.40/specifications/function.yaml create mode 100644 releases/8.40/specifications/grant.yaml create mode 100644 releases/8.40/specifications/image-repository.yaml create mode 100644 releases/8.40/specifications/network-policy.yaml create mode 100644 releases/8.40/specifications/notebook.yaml create mode 100644 releases/8.40/specifications/notification-integration.yaml create mode 100644 releases/8.40/specifications/pipe.yaml create mode 100644 releases/8.40/specifications/procedure.yaml create mode 100644 releases/8.40/specifications/result.yaml create mode 100644 releases/8.40/specifications/role.yaml create mode 100644 releases/8.40/specifications/schema.yaml create mode 100644 releases/8.40/specifications/service.yaml create mode 100644 releases/8.40/specifications/stage.yaml create mode 100644 releases/8.40/specifications/stream.yaml create mode 100644 releases/8.40/specifications/table.yaml create mode 100644 releases/8.40/specifications/task.yaml create mode 100644 releases/8.40/specifications/user-defined-function.yaml create mode 100644 releases/8.40/specifications/user.yaml create mode 100644 releases/8.40/specifications/view.yaml create mode 100644 releases/8.40/specifications/warehouse.yaml diff --git a/releases/8.40/collections/Cortex Analyst API.postman_collection.json b/releases/8.40/collections/Cortex Analyst API.postman_collection.json new file mode 100644 index 0000000..1a811e5 --- /dev/null +++ b/releases/8.40/collections/Cortex Analyst API.postman_collection.json @@ -0,0 +1,716 @@ +{ + "info": { + "_postman_id": "b968c86d-64be-45c8-8534-7d2025a7043e", + "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" + }, + "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\": \"analyst\"\n },\n {\n \"content\": [\n {\n \"type\": \"text\"\n },\n {\n \"type\": \"text\"\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" + ] + }, + "description": "Send a data question to the Cortex Analyst" + }, + "response": [ + { + "name": "OK", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"messages\": [\n {\n \"content\": [\n {\n \"type\": \"sql\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"analyst\"\n },\n {\n \"content\": [\n {\n \"type\": \"text\"\n },\n {\n \"type\": \"text\"\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\": \"user\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"messages\": [\n {\n \"content\": [\n {\n \"type\": \"sql\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"analyst\"\n },\n {\n \"content\": [\n {\n \"type\": \"text\"\n },\n {\n \"type\": \"text\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"messages\": [\n {\n \"content\": [\n {\n \"type\": \"sql\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"analyst\"\n },\n {\n \"content\": [\n {\n \"type\": \"text\"\n },\n {\n \"type\": \"text\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"messages\": [\n {\n \"content\": [\n {\n \"type\": \"sql\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"analyst\"\n },\n {\n \"content\": [\n {\n \"type\": \"text\"\n },\n {\n \"type\": \"text\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"messages\": [\n {\n \"content\": [\n {\n \"type\": \"sql\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"analyst\"\n },\n {\n \"content\": [\n {\n \"type\": \"text\"\n },\n {\n \"type\": \"text\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"messages\": [\n {\n \"content\": [\n {\n \"type\": \"sql\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"analyst\"\n },\n {\n \"content\": [\n {\n \"type\": \"text\"\n },\n {\n \"type\": \"text\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"messages\": [\n {\n \"content\": [\n {\n \"type\": \"sql\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"analyst\"\n },\n {\n \"content\": [\n {\n \"type\": \"text\"\n },\n {\n \"type\": \"text\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"messages\": [\n {\n \"content\": [\n {\n \"type\": \"sql\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"analyst\"\n },\n {\n \"content\": [\n {\n \"type\": \"text\"\n },\n {\n \"type\": \"text\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"messages\": [\n {\n \"content\": [\n {\n \"type\": \"sql\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"analyst\"\n },\n {\n \"content\": [\n {\n \"type\": \"text\"\n },\n {\n \"type\": \"text\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"messages\": [\n {\n \"content\": [\n {\n \"type\": \"sql\"\n },\n {\n \"type\": \"sql\"\n }\n ],\n \"role\": \"analyst\"\n },\n {\n \"content\": [\n {\n \"type\": \"text\"\n },\n {\n \"type\": \"text\"\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}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + } + ] +} \ No newline at end of file diff --git a/releases/8.40/collections/Cortex Inference API.postman_collection.json b/releases/8.40/collections/Cortex Inference API.postman_collection.json new file mode 100644 index 0000000..4d06445 --- /dev/null +++ b/releases/8.40/collections/Cortex Inference API.postman_collection.json @@ -0,0 +1,638 @@ +{ + "info": { + "_postman_id": "344d3869-22b2-4983-ac97-d949dc9de866", + "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" + }, + "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": "text/event-stream" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"model\": \"\",\n \"messages\": [\n {\n \"content\": \"\"\n }\n ],\n \"temperature\": 0,\n \"top_p\": 1,\n \"max_tokens\": 4096,\n \"guardrails\": {\n \"enabled\": \"\",\n \"response_when_unsafe\": \"\"\n }\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": "text/event-stream" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"model\": \"\",\n \"messages\": [\n {\n \"content\": \"\"\n }\n ],\n \"temperature\": 0,\n \"top_p\": 1,\n \"max_tokens\": 4096,\n \"guardrails\": {\n \"enabled\": \"\",\n \"response_when_unsafe\": \"\"\n }\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": "text", + "header": [ + { + "key": "Content-Type", + "value": "text/event-stream" + } + ], + "cookie": [], + "body": "{}" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"model\": \"\",\n \"messages\": [\n {\n \"content\": \"\"\n }\n ],\n \"temperature\": 0,\n \"top_p\": 1,\n \"max_tokens\": 4096,\n \"guardrails\": {\n \"enabled\": \"\",\n \"response_when_unsafe\": \"\"\n }\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"model\": \"\",\n \"messages\": [\n {\n \"content\": \"\"\n }\n ],\n \"temperature\": 0,\n \"top_p\": 1,\n \"max_tokens\": 4096,\n \"guardrails\": {\n \"enabled\": \"\",\n \"response_when_unsafe\": \"\"\n }\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"model\": \"\",\n \"messages\": [\n {\n \"content\": \"\"\n }\n ],\n \"temperature\": 0,\n \"top_p\": 1,\n \"max_tokens\": 4096,\n \"guardrails\": {\n \"enabled\": \"\",\n \"response_when_unsafe\": \"\"\n }\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"model\": \"\",\n \"messages\": [\n {\n \"content\": \"\"\n }\n ],\n \"temperature\": 0,\n \"top_p\": 1,\n \"max_tokens\": 4096,\n \"guardrails\": {\n \"enabled\": \"\",\n \"response_when_unsafe\": \"\"\n }\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"model\": \"\",\n \"messages\": [\n {\n \"content\": \"\"\n }\n ],\n \"temperature\": 0,\n \"top_p\": 1,\n \"max_tokens\": 4096,\n \"guardrails\": {\n \"enabled\": \"\",\n \"response_when_unsafe\": \"\"\n }\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"model\": \"\",\n \"messages\": [\n {\n \"content\": \"\"\n }\n ],\n \"temperature\": 0,\n \"top_p\": 1,\n \"max_tokens\": 4096,\n \"guardrails\": {\n \"enabled\": \"\",\n \"response_when_unsafe\": \"\"\n }\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"model\": \"\",\n \"messages\": [\n {\n \"content\": \"\"\n }\n ],\n \"temperature\": 0,\n \"top_p\": 1,\n \"max_tokens\": 4096,\n \"guardrails\": {\n \"enabled\": \"\",\n \"response_when_unsafe\": \"\"\n }\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"model\": \"\",\n \"messages\": [\n {\n \"content\": \"\"\n }\n ],\n \"temperature\": 0,\n \"top_p\": 1,\n \"max_tokens\": 4096,\n \"guardrails\": {\n \"enabled\": \"\",\n \"response_when_unsafe\": \"\"\n }\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}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "variable": [ + { + "key": "baseUrl", + "value": "/" + } + ] +} \ No newline at end of file diff --git a/releases/8.40/collections/Cortex Search REST API.postman_collection.json b/releases/8.40/collections/Cortex Search REST API.postman_collection.json new file mode 100644 index 0000000..56b02e2 --- /dev/null +++ b/releases/8.40/collections/Cortex Search REST API.postman_collection.json @@ -0,0 +1,934 @@ +{ + "info": { + "_postman_id": "98252505-067b-4aa7-b13a-cd7681f3aadd", + "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" + }, + "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 \"incididunt57\": \"sit\"\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": "\"\"\"\"\"p\"\"u[\"", + "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": "\"\"\"\"\"p\"\"u[\"", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"query\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"filter\": {},\n \"limit\": 10,\n \"experimental\": {\n \"incididunt57\": \"sit\"\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 \"ullamco__c\": \"esse qui Duis\",\n \"Duisf_2\": 68525705.43710405,\n \"exercitation_3\": -46094729.717254035,\n \"aute__7\": 21451075.709170103,\n \"cupidatat_8\": 35441972\n },\n {\n \"adipisicing0ed\": 24041279.259013444\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"query\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"filter\": {},\n \"limit\": 10,\n \"experimental\": {\n \"incididunt57\": \"sit\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"query\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"filter\": {},\n \"limit\": 10,\n \"experimental\": {\n \"incididunt57\": \"sit\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"query\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"filter\": {},\n \"limit\": 10,\n \"experimental\": {\n \"incididunt57\": \"sit\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"query\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"filter\": {},\n \"limit\": 10,\n \"experimental\": {\n \"incididunt57\": \"sit\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"query\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"filter\": {},\n \"limit\": 10,\n \"experimental\": {\n \"incididunt57\": \"sit\"\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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"query\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"filter\": {},\n \"limit\": 10,\n \"experimental\": {\n \"incididunt57\": \"sit\"\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": "Request Timeout", + "code": 408, + "_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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"query\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"filter\": {},\n \"limit\": 10,\n \"experimental\": {\n \"incididunt57\": \"sit\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"query\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"filter\": {},\n \"limit\": 10,\n \"experimental\": {\n \"incididunt57\": \"sit\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"query\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"filter\": {},\n \"limit\": 10,\n \"experimental\": {\n \"incididunt57\": \"sit\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"query\": \"\",\n \"columns\": [\n \"\",\n \"\"\n ],\n \"filter\": {},\n \"limit\": 10,\n \"experimental\": {\n \"incididunt57\": \"sit\"\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}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "variable": [ + { + "key": "baseUrl", + "value": "/" + }, + { + "key": "service_name", + "value": "" + } + ] +} \ No newline at end of file diff --git a/releases/8.40/collections/Snowflake Account API.postman_collection.json b/releases/8.40/collections/Snowflake Account API.postman_collection.json new file mode 100644 index 0000000..910375d --- /dev/null +++ b/releases/8.40/collections/Snowflake Account API.postman_collection.json @@ -0,0 +1,3576 @@ +{ + "info": { + "_postman_id": "83e0ad4e-1328-4c09-a74e-bd1a706a3a66", + "name": "Snowflake Account API", + "description": "The Snowflake Account API is a REST API that you can use to access, update, and perform certain actions on Account 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" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "accounts", + "item": [ + { + "name": "{name}", + "item": [ + { + "name": "Deletes a account.", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts/:name?ifExists=false&gracePeriodInDays=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts", + ":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": "gracePeriodInDays", + "value": "", + "description": "(Required) Specifies the number of days during which the account can be restored (“undropped”). The minimum is 3 days and the maximum is 90 days." + } + ], + "variable": [ + { + "key": "name", + "value": "t4", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Deletes the specified account. If you enable the `ifExists` parameter, the operation succeeds even if the account does not exist. Otherwise, a 404 failure is returned if the account does not exist. if the drop is unsuccessful." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts/:name?ifExists=false&gracePeriodInDays=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts", + ":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": "gracePeriodInDays", + "value": "", + "description": "(Required) Specifies the number of days during which the account can be restored (“undropped”). The minimum is 3 days and the maximum is 90 days." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts/:name?ifExists=false&gracePeriodInDays=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts", + ":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": "gracePeriodInDays", + "value": "", + "description": "(Required) Specifies the number of days during which the account can be restored (“undropped”). The minimum is 3 days and the maximum is 90 days." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts/:name?ifExists=false&gracePeriodInDays=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts", + ":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": "gracePeriodInDays", + "value": "", + "description": "(Required) Specifies the number of days during which the account can be restored (“undropped”). The minimum is 3 days and the maximum is 90 days." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts/:name?ifExists=false&gracePeriodInDays=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts", + ":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": "gracePeriodInDays", + "value": "", + "description": "(Required) Specifies the number of days during which the account can be restored (“undropped”). The minimum is 3 days and the maximum is 90 days." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts/:name?ifExists=false&gracePeriodInDays=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts", + ":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": "gracePeriodInDays", + "value": "", + "description": "(Required) Specifies the number of days during which the account can be restored (“undropped”). The minimum is 3 days and the maximum is 90 days." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts/:name?ifExists=false&gracePeriodInDays=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts", + ":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": "gracePeriodInDays", + "value": "", + "description": "(Required) Specifies the number of days during which the account can be restored (“undropped”). The minimum is 3 days and the maximum is 90 days." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts/:name?ifExists=false&gracePeriodInDays=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts", + ":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": "gracePeriodInDays", + "value": "", + "description": "(Required) Specifies the number of days during which the account can be restored (“undropped”). The minimum is 3 days and the maximum is 90 days." + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts/:name?ifExists=false&gracePeriodInDays=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts", + ":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": "gracePeriodInDays", + "value": "", + "description": "(Required) Specifies the number of days during which the account can be restored (“undropped”). The minimum is 3 days and the maximum is 90 days." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts/:name?ifExists=false&gracePeriodInDays=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts", + ":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": "gracePeriodInDays", + "value": "", + "description": "(Required) Specifies the number of days during which the account can be restored (“undropped”). The minimum is 3 days and the maximum is 90 days." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts/:name?ifExists=false&gracePeriodInDays=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts", + ":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": "gracePeriodInDays", + "value": "", + "description": "(Required) Specifies the number of days during which the account can be restored (“undropped”). The minimum is 3 days and the maximum is 90 days." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts/:name?ifExists=false&gracePeriodInDays=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts", + ":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": "gracePeriodInDays", + "value": "", + "description": "(Required) Specifies the number of days during which the account can be restored (“undropped”). The minimum is 3 days and the maximum is 90 days." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts/:name?ifExists=false&gracePeriodInDays=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts", + ":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": "gracePeriodInDays", + "value": "", + "description": "(Required) Specifies the number of days during which the account can be restored (“undropped”). The minimum is 3 days and the maximum is 90 days." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts/:name?ifExists=false&gracePeriodInDays=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts", + ":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": "gracePeriodInDays", + "value": "", + "description": "(Required) Specifies the number of days during which the account can be restored (“undropped”). The minimum is 3 days and the maximum is 90 days." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts/:name?ifExists=false&gracePeriodInDays=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts", + ":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": "gracePeriodInDays", + "value": "", + "description": "(Required) Specifies the number of days during which the account can be restored (“undropped”). The minimum is 3 days and the maximum is 90 days." + } + ], + "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}:undrop", + "item": [ + { + "name": "Restore a account.", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts", + "{{name}}:undrop" + ] + }, + "description": "Restores a dropped account that has not yet been permanently deleted (a dropped account that is within its grace period)." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts", + "{{name}}:undrop" + ] + } + }, + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts", + "{{name}}:undrop" + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts", + "{{name}}:undrop" + ] + } + }, + "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 accounts.", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts?like=&showLimit=&history=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts" + ], + "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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "history", + "value": "", + "description": "Optionally includes dropped accounts that have not yet been purged." + } + ] + }, + "description": "Lists the accessible accounts." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts?like=&showLimit=&history=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts" + ], + "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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "history", + "value": "", + "description": "Optionally includes dropped accounts 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\": \"_5_KcqAqh\",\n \"edition\": \"BUSINESS_CRITICAL\",\n \"organization_name\": \"\",\n \"region_group\": \"\",\n \"region\": \"\",\n \"created_on\": \"\",\n \"account_url\": \"\",\n \"account_locator\": \"\",\n \"account_locator_url\": \"\",\n \"managed_accounts\": \"\",\n \"consumption_billing_entity_name\": \"\",\n \"marketplace_consumer_billing_entity_name\": \"\",\n \"marketplace_provider_billing_entity_name\": \"\",\n \"old_account_url\": \"\",\n \"comment\": \"\",\n \"is_org_admin\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"scheduled_deletion_time\": \"\",\n \"restored_on\": \"\",\n \"account_old_url_saved_on\": \"\",\n \"account_old_url_last_used\": \"\",\n \"organization_old_url\": \"\",\n \"organization_old_url_saved_on\": \"\",\n \"organization_old_url_last_used\": \"\",\n \"organization_URL_expiration_on\": \"\",\n \"moved_on\": \"\",\n \"is_events_account\": \"\",\n \"moved_to_organization\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"k\\\"\",\n \"edition\": \"BUSINESS_CRITICAL\",\n \"organization_name\": \"\",\n \"region_group\": \"\",\n \"region\": \"\",\n \"created_on\": \"\",\n \"account_url\": \"\",\n \"account_locator\": \"\",\n \"account_locator_url\": \"\",\n \"managed_accounts\": \"\",\n \"consumption_billing_entity_name\": \"\",\n \"marketplace_consumer_billing_entity_name\": \"\",\n \"marketplace_provider_billing_entity_name\": \"\",\n \"old_account_url\": \"\",\n \"comment\": \"\",\n \"is_org_admin\": \"\",\n \"retention_time\": \"\",\n \"dropped_on\": \"\",\n \"scheduled_deletion_time\": \"\",\n \"restored_on\": \"\",\n \"account_old_url_saved_on\": \"\",\n \"account_old_url_last_used\": \"\",\n \"organization_old_url\": \"\",\n \"organization_old_url_saved_on\": \"\",\n \"organization_old_url_last_used\": \"\",\n \"organization_URL_expiration_on\": \"\",\n \"moved_on\": \"\",\n \"is_events_account\": \"\",\n \"moved_to_organization\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts?like=&showLimit=&history=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts" + ], + "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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "history", + "value": "", + "description": "Optionally includes dropped accounts 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts?like=&showLimit=&history=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts" + ], + "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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "history", + "value": "", + "description": "Optionally includes dropped accounts 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts?like=&showLimit=&history=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts" + ], + "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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "history", + "value": "", + "description": "Optionally includes dropped accounts 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts?like=&showLimit=&history=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts" + ], + "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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "history", + "value": "", + "description": "Optionally includes dropped accounts 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts?like=&showLimit=&history=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts" + ], + "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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "history", + "value": "", + "description": "Optionally includes dropped accounts 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts?like=&showLimit=&history=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts" + ], + "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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "history", + "value": "", + "description": "Optionally includes dropped accounts 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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts?like=&showLimit=&history=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts" + ], + "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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "history", + "value": "", + "description": "Optionally includes dropped accounts that have not yet been purged." + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts?like=&showLimit=&history=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts" + ], + "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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "history", + "value": "", + "description": "Optionally includes dropped accounts 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts?like=&showLimit=&history=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts" + ], + "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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "history", + "value": "", + "description": "Optionally includes dropped accounts 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts?like=&showLimit=&history=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts" + ], + "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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "history", + "value": "", + "description": "Optionally includes dropped accounts 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts?like=&showLimit=&history=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts" + ], + "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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "history", + "value": "", + "description": "Optionally includes dropped accounts 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts?like=&showLimit=&history=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts" + ], + "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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "history", + "value": "", + "description": "Optionally includes dropped accounts 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/accounts?like=&showLimit=&history=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts" + ], + "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": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + }, + { + "key": "history", + "value": "", + "description": "Optionally includes dropped accounts 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 account.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"NDJ\\\"\\\"\\\"\\\"\\\"\\\"L4\\\"\\\"\\\"\",\n \"admin_name\": \"\",\n \"email\": \"\",\n \"edition\": \"STANDARD\",\n \"region_group\": \"\",\n \"region\": \"\",\n \"comment\": \"\",\n \"admin_password\": \"\",\n \"admin_rsa_public_key\": \"\",\n \"admin_user_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"must_change_password\": false,\n \"polaris\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/accounts", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts" + ] + }, + "description": "Creates a account. You must provide the full account definition when creating a account." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"NDJ\\\"\\\"\\\"\\\"\\\"\\\"L4\\\"\\\"\\\"\",\n \"admin_name\": \"\",\n \"email\": \"\",\n \"edition\": \"STANDARD\",\n \"region_group\": \"\",\n \"region\": \"\",\n \"comment\": \"\",\n \"admin_password\": \"\",\n \"admin_rsa_public_key\": \"\",\n \"admin_user_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"must_change_password\": false,\n \"polaris\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/accounts", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"NDJ\\\"\\\"\\\"\\\"\\\"\\\"L4\\\"\\\"\\\"\",\n \"admin_name\": \"\",\n \"email\": \"\",\n \"edition\": \"STANDARD\",\n \"region_group\": \"\",\n \"region\": \"\",\n \"comment\": \"\",\n \"admin_password\": \"\",\n \"admin_rsa_public_key\": \"\",\n \"admin_user_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"must_change_password\": false,\n \"polaris\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/accounts", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"NDJ\\\"\\\"\\\"\\\"\\\"\\\"L4\\\"\\\"\\\"\",\n \"admin_name\": \"\",\n \"email\": \"\",\n \"edition\": \"STANDARD\",\n \"region_group\": \"\",\n \"region\": \"\",\n \"comment\": \"\",\n \"admin_password\": \"\",\n \"admin_rsa_public_key\": \"\",\n \"admin_user_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"must_change_password\": false,\n \"polaris\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/accounts", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"NDJ\\\"\\\"\\\"\\\"\\\"\\\"L4\\\"\\\"\\\"\",\n \"admin_name\": \"\",\n \"email\": \"\",\n \"edition\": \"STANDARD\",\n \"region_group\": \"\",\n \"region\": \"\",\n \"comment\": \"\",\n \"admin_password\": \"\",\n \"admin_rsa_public_key\": \"\",\n \"admin_user_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"must_change_password\": false,\n \"polaris\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/accounts", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"NDJ\\\"\\\"\\\"\\\"\\\"\\\"L4\\\"\\\"\\\"\",\n \"admin_name\": \"\",\n \"email\": \"\",\n \"edition\": \"STANDARD\",\n \"region_group\": \"\",\n \"region\": \"\",\n \"comment\": \"\",\n \"admin_password\": \"\",\n \"admin_rsa_public_key\": \"\",\n \"admin_user_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"must_change_password\": false,\n \"polaris\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/accounts", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"NDJ\\\"\\\"\\\"\\\"\\\"\\\"L4\\\"\\\"\\\"\",\n \"admin_name\": \"\",\n \"email\": \"\",\n \"edition\": \"STANDARD\",\n \"region_group\": \"\",\n \"region\": \"\",\n \"comment\": \"\",\n \"admin_password\": \"\",\n \"admin_rsa_public_key\": \"\",\n \"admin_user_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"must_change_password\": false,\n \"polaris\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/accounts", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"NDJ\\\"\\\"\\\"\\\"\\\"\\\"L4\\\"\\\"\\\"\",\n \"admin_name\": \"\",\n \"email\": \"\",\n \"edition\": \"STANDARD\",\n \"region_group\": \"\",\n \"region\": \"\",\n \"comment\": \"\",\n \"admin_password\": \"\",\n \"admin_rsa_public_key\": \"\",\n \"admin_user_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"must_change_password\": false,\n \"polaris\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/accounts", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts" + ] + } + }, + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"NDJ\\\"\\\"\\\"\\\"\\\"\\\"L4\\\"\\\"\\\"\",\n \"admin_name\": \"\",\n \"email\": \"\",\n \"edition\": \"STANDARD\",\n \"region_group\": \"\",\n \"region\": \"\",\n \"comment\": \"\",\n \"admin_password\": \"\",\n \"admin_rsa_public_key\": \"\",\n \"admin_user_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"must_change_password\": false,\n \"polaris\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/accounts", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts" + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"NDJ\\\"\\\"\\\"\\\"\\\"\\\"L4\\\"\\\"\\\"\",\n \"admin_name\": \"\",\n \"email\": \"\",\n \"edition\": \"STANDARD\",\n \"region_group\": \"\",\n \"region\": \"\",\n \"comment\": \"\",\n \"admin_password\": \"\",\n \"admin_rsa_public_key\": \"\",\n \"admin_user_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"must_change_password\": false,\n \"polaris\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/accounts", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"NDJ\\\"\\\"\\\"\\\"\\\"\\\"L4\\\"\\\"\\\"\",\n \"admin_name\": \"\",\n \"email\": \"\",\n \"edition\": \"STANDARD\",\n \"region_group\": \"\",\n \"region\": \"\",\n \"comment\": \"\",\n \"admin_password\": \"\",\n \"admin_rsa_public_key\": \"\",\n \"admin_user_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"must_change_password\": false,\n \"polaris\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/accounts", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"NDJ\\\"\\\"\\\"\\\"\\\"\\\"L4\\\"\\\"\\\"\",\n \"admin_name\": \"\",\n \"email\": \"\",\n \"edition\": \"STANDARD\",\n \"region_group\": \"\",\n \"region\": \"\",\n \"comment\": \"\",\n \"admin_password\": \"\",\n \"admin_rsa_public_key\": \"\",\n \"admin_user_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"must_change_password\": false,\n \"polaris\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/accounts", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"NDJ\\\"\\\"\\\"\\\"\\\"\\\"L4\\\"\\\"\\\"\",\n \"admin_name\": \"\",\n \"email\": \"\",\n \"edition\": \"STANDARD\",\n \"region_group\": \"\",\n \"region\": \"\",\n \"comment\": \"\",\n \"admin_password\": \"\",\n \"admin_rsa_public_key\": \"\",\n \"admin_user_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"must_change_password\": false,\n \"polaris\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/accounts", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"NDJ\\\"\\\"\\\"\\\"\\\"\\\"L4\\\"\\\"\\\"\",\n \"admin_name\": \"\",\n \"email\": \"\",\n \"edition\": \"STANDARD\",\n \"region_group\": \"\",\n \"region\": \"\",\n \"comment\": \"\",\n \"admin_password\": \"\",\n \"admin_rsa_public_key\": \"\",\n \"admin_user_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"must_change_password\": false,\n \"polaris\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/accounts", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"NDJ\\\"\\\"\\\"\\\"\\\"\\\"L4\\\"\\\"\\\"\",\n \"admin_name\": \"\",\n \"email\": \"\",\n \"edition\": \"STANDARD\",\n \"region_group\": \"\",\n \"region\": \"\",\n \"comment\": \"\",\n \"admin_password\": \"\",\n \"admin_rsa_public_key\": \"\",\n \"admin_user_type\": \"\",\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"must_change_password\": false,\n \"polaris\": false\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/accounts", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "accounts" + ] + } + }, + "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}" + } + ] + } + ] + } + ] + } + ] + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + }, + { + "key": "name", + "value": "t4" + } + ] +} \ No newline at end of file diff --git a/releases/8.40/collections/Snowflake Alert API.postman_collection.json b/releases/8.40/collections/Snowflake Alert API.postman_collection.json new file mode 100644 index 0000000..751dbcd --- /dev/null +++ b/releases/8.40/collections/Snowflake Alert API.postman_collection.json @@ -0,0 +1,6706 @@ +{ + "info": { + "_postman_id": "ea5b0b57-7b30-43e0-952a-077b5573daa0", + "name": "Snowflake Alert API", + "description": "The Snowflake Alert API is a REST API that you can use to access, update, and perform certain actions on Alert 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" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "databases", + "item": [ + { + "name": "{database}", + "item": [ + { + "name": "schemas", + "item": [ + { + "name": "{schema}", + "item": [ + { + "name": "alerts", + "item": [ + { + "name": "{name}", + "item": [ + { + "name": "Fetch an alert", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + ":name" + ], + "variable": [ + { + "key": "database", + "value": "\"&\"\"|\"\"\"\"\"\"\"\"\"\"8]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": "\"&\"\"|\"\"\"\"\"\"\"\"\"\"8]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": "\"&\"\"|\"\"\"\"\"\"\"\"\"\"8]M\"", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Fetch an alert" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + ":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 \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"condition\": \"\",\n \"action\": \"\",\n \"comment\": \"\",\n \"warehouse\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + ":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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + ":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 an alert", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + ":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": "\"&\"\"|\"\"\"\"\"\"\"\"\"\"8]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": "\"&\"\"|\"\"\"\"\"\"\"\"\"\"8]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": "\"&\"\"|\"\"\"\"\"\"\"\"\"\"8]M\"", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Delete an alert" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + ":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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + ":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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + ":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": "Create a new alert by cloning from the specified resource", + "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\": \"\",\n \"reference\": \"at\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/{{name}}:clone?createMode=errorIfExists&targetDatabase=&targetSchema=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + "{{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": "targetDatabase", + "value": "", + "description": "(Required) Database of the newly created resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "", + "description": "(Required) Schema of the newly created resource. Defaults to the source's schema" + } + ], + "variable": [ + { + "key": "database", + "value": "\"&\"\"|\"\"\"\"\"\"\"\"\"\"8]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": "\"&\"\"|\"\"\"\"\"\"\"\"\"\"8]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 alert 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"\",\n \"reference\": \"at\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/{{name}}:clone?createMode=errorIfExists&targetDatabase=&targetSchema=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + "{{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": "targetDatabase", + "value": "", + "description": "(Required) Database of the newly created resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "", + "description": "(Required) Schema of the newly created resource. Defaults to the source'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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"\",\n \"reference\": \"at\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/{{name}}:clone?createMode=errorIfExists&targetDatabase=&targetSchema=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + "{{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": "targetDatabase", + "value": "", + "description": "(Required) Database of the newly created resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "", + "description": "(Required) Schema of the newly created resource. Defaults to the source'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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"\",\n \"reference\": \"at\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/{{name}}:clone?createMode=errorIfExists&targetDatabase=&targetSchema=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + "{{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": "targetDatabase", + "value": "", + "description": "(Required) Database of the newly created resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "", + "description": "(Required) Schema of the newly created resource. Defaults to the source'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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"\",\n \"reference\": \"at\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/{{name}}:clone?createMode=errorIfExists&targetDatabase=&targetSchema=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + "{{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": "targetDatabase", + "value": "", + "description": "(Required) Database of the newly created resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "", + "description": "(Required) Schema of the newly created resource. Defaults to the source'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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"\",\n \"reference\": \"at\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/{{name}}:clone?createMode=errorIfExists&targetDatabase=&targetSchema=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + "{{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": "targetDatabase", + "value": "", + "description": "(Required) Database of the newly created resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "", + "description": "(Required) Schema of the newly created resource. Defaults to the source'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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"\",\n \"reference\": \"at\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/{{name}}:clone?createMode=errorIfExists&targetDatabase=&targetSchema=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + "{{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": "targetDatabase", + "value": "", + "description": "(Required) Database of the newly created resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "", + "description": "(Required) Schema of the newly created resource. Defaults to the source'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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"\",\n \"reference\": \"at\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/{{name}}:clone?createMode=errorIfExists&targetDatabase=&targetSchema=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + "{{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": "targetDatabase", + "value": "", + "description": "(Required) Database of the newly created resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "", + "description": "(Required) Schema of the newly created resource. Defaults to the source'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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"\",\n \"reference\": \"at\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/{{name}}:clone?createMode=errorIfExists&targetDatabase=&targetSchema=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + "{{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": "targetDatabase", + "value": "", + "description": "(Required) Database of the newly created resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "", + "description": "(Required) Schema of the newly created resource. Defaults to the source's schema" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"\",\n \"reference\": \"at\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/{{name}}:clone?createMode=errorIfExists&targetDatabase=&targetSchema=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + "{{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": "targetDatabase", + "value": "", + "description": "(Required) Database of the newly created resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "", + "description": "(Required) Schema of the newly created resource. Defaults to the source'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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"\",\n \"reference\": \"at\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/{{name}}:clone?createMode=errorIfExists&targetDatabase=&targetSchema=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + "{{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": "targetDatabase", + "value": "", + "description": "(Required) Database of the newly created resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "", + "description": "(Required) Schema of the newly created resource. Defaults to the source'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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"\",\n \"reference\": \"at\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/{{name}}:clone?createMode=errorIfExists&targetDatabase=&targetSchema=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + "{{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": "targetDatabase", + "value": "", + "description": "(Required) Database of the newly created resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "", + "description": "(Required) Schema of the newly created resource. Defaults to the source'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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"\",\n \"reference\": \"at\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/{{name}}:clone?createMode=errorIfExists&targetDatabase=&targetSchema=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + "{{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": "targetDatabase", + "value": "", + "description": "(Required) Database of the newly created resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "", + "description": "(Required) Schema of the newly created resource. Defaults to the source'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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"\",\n \"reference\": \"at\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/{{name}}:clone?createMode=errorIfExists&targetDatabase=&targetSchema=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + "{{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": "targetDatabase", + "value": "", + "description": "(Required) Database of the newly created resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "", + "description": "(Required) Schema of the newly created resource. Defaults to the source'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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"\",\n \"reference\": \"at\"\n }\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/{{name}}:clone?createMode=errorIfExists&targetDatabase=&targetSchema=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + "{{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": "targetDatabase", + "value": "", + "description": "(Required) Database of the newly created resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "", + "description": "(Required) Schema of the newly created resource. Defaults to the source'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}:execute", + "item": [ + { + "name": "Execute an alert", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/{{name}}:execute", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + "{{name}}:execute" + ], + "variable": [ + { + "key": "database", + "value": "\"&\"\"|\"\"\"\"\"\"\"\"\"\"8]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": "\"&\"\"|\"\"\"\"\"\"\"\"\"\"8]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": "Execute an alert" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/{{name}}:execute", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + "{{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": "{\n \"status\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/{{name}}:execute", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + "{{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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/{{name}}:execute", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + "{{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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/{{name}}:execute", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + "{{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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/{{name}}:execute", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + "{{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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/{{name}}:execute", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + "{{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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/{{name}}:execute", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + "{{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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/{{name}}:execute", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + "{{name}}:execute" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/{{name}}:execute", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + "{{name}}:execute" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/{{name}}:execute", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + "{{name}}:execute" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/{{name}}:execute", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + "{{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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/{{name}}:execute", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + "{{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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/{{name}}:execute", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + "{{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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts/{{name}}:execute", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts", + "{{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 alerts", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts" + ], + "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": "\"&\"\"|\"\"\"\"\"\"\"\"\"\"8]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": "\"&\"\"|\"\"\"\"\"\"\"\"\"\"8]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": "List alerts" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts" + ], + "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\": \"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"condition\": \"\",\n \"action\": \"\",\n \"comment\": \"\",\n \"warehouse\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"\"\n },\n {\n \"name\": \"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"condition\": \"\",\n \"action\": \"\",\n \"comment\": \"\",\n \"warehouse\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts" + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts" + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts" + ], + "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": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts" + ], + "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": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts" + ], + "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 an alert", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"condition\": \"\",\n \"action\": \"\",\n \"comment\": \"\",\n \"warehouse\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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": "\"&\"\"|\"\"\"\"\"\"\"\"\"\"8]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": "\"&\"\"|\"\"\"\"\"\"\"\"\"\"8]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 an alert" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"condition\": \"\",\n \"action\": \"\",\n \"comment\": \"\",\n \"warehouse\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"condition\": \"\",\n \"action\": \"\",\n \"comment\": \"\",\n \"warehouse\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"condition\": \"\",\n \"action\": \"\",\n \"comment\": \"\",\n \"warehouse\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"condition\": \"\",\n \"action\": \"\",\n \"comment\": \"\",\n \"warehouse\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"condition\": \"\",\n \"action\": \"\",\n \"comment\": \"\",\n \"warehouse\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"condition\": \"\",\n \"action\": \"\",\n \"comment\": \"\",\n \"warehouse\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"condition\": \"\",\n \"action\": \"\",\n \"comment\": \"\",\n \"warehouse\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"condition\": \"\",\n \"action\": \"\",\n \"comment\": \"\",\n \"warehouse\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"condition\": \"\",\n \"action\": \"\",\n \"comment\": \"\",\n \"warehouse\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"condition\": \"\",\n \"action\": \"\",\n \"comment\": \"\",\n \"warehouse\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"condition\": \"\",\n \"action\": \"\",\n \"comment\": \"\",\n \"warehouse\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"condition\": \"\",\n \"action\": \"\",\n \"comment\": \"\",\n \"warehouse\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"condition\": \"\",\n \"action\": \"\",\n \"comment\": \"\",\n \"warehouse\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"condition\": \"\",\n \"action\": \"\",\n \"comment\": \"\",\n \"warehouse\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/alerts?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "alerts" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + }, + { + "key": "name", + "value": "\"&\"\"|\"\"\"\"\"\"\"\"\"\"8]M\"" + } + ] +} \ No newline at end of file diff --git a/releases/8.40/collections/Snowflake Catalog Integration API.postman_collection.json b/releases/8.40/collections/Snowflake Catalog Integration API.postman_collection.json new file mode 100644 index 0000000..a557024 --- /dev/null +++ b/releases/8.40/collections/Snowflake Catalog Integration API.postman_collection.json @@ -0,0 +1,3234 @@ +{ + "info": { + "_postman_id": "a3071606-f7fc-4626-8a28-0e1d644854fc", + "name": "Snowflake Catalog Integration API", + "description": "The Snowflake Catalog Integration API is a REST API that you can use to access, update, and perform certain actions on Catalog Integration 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" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "catalog-integrations", + "item": [ + { + "name": "{name}", + "item": [ + { + "name": "Fetch a catalog integration.", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/catalog-integrations/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations", + ":name" + ], + "variable": [ + { + "key": "name", + "value": "ZSgZ", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Fetch a catalog integration." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/catalog-integrations/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations", + ":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\": \"C_ToVIZiRE\",\n \"catalog\": {\n \"catalog_source\": \"POLARIS\"\n },\n \"table_format\": \"ICEBERG\",\n \"enabled\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"category\": \"\",\n \"created_on\": \"\"\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/catalog-integrations/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations", + ":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/catalog-integrations/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations", + ":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/catalog-integrations/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations", + ":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/catalog-integrations/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations", + ":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/catalog-integrations/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations", + ":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/catalog-integrations/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations", + ":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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/catalog-integrations/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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/catalog-integrations/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations", + ":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/catalog-integrations/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations", + ":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/catalog-integrations/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations", + ":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/catalog-integrations/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations", + ":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/catalog-integrations/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations", + ":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/catalog-integrations/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations", + ":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 catalog integration.", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/catalog-integrations/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations", + ":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": "ZSgZ", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Delete a catalog integration." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/catalog-integrations/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations", + ":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/catalog-integrations/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations", + ":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/catalog-integrations/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations", + ":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/catalog-integrations/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations", + ":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/catalog-integrations/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations", + ":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/catalog-integrations/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations", + ":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/catalog-integrations/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations", + ":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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/catalog-integrations/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations", + ":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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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/catalog-integrations/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations", + ":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/catalog-integrations/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations", + ":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/catalog-integrations/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations", + ":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/catalog-integrations/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations", + ":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/catalog-integrations/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations", + ":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/catalog-integrations/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations", + ":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": "List catalog integrations.", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/catalog-integrations?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations" + ], + "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": "List catalog integrations." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/catalog-integrations?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations" + ], + "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\": \"mBmHfH$x_lm\",\n \"catalog\": {\n \"catalog_source\": \"OBJECT_STORE\"\n },\n \"table_format\": \"ICEBERG\",\n \"enabled\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"category\": \"\",\n \"created_on\": \"\"\n },\n {\n \"name\": \"hBHBTD\",\n \"catalog\": {\n \"catalog_source\": \"GLUE\"\n },\n \"table_format\": \"ICEBERG\",\n \"enabled\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"category\": \"\",\n \"created_on\": \"\"\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/catalog-integrations?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations" + ], + "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/catalog-integrations?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations" + ], + "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/catalog-integrations?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations" + ], + "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/catalog-integrations?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations" + ], + "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/catalog-integrations?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations" + ], + "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/catalog-integrations?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations" + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/catalog-integrations?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations" + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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/catalog-integrations?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations" + ], + "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/catalog-integrations?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations" + ], + "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/catalog-integrations?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations" + ], + "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/catalog-integrations?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations" + ], + "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/catalog-integrations?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations" + ], + "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/catalog-integrations?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations" + ], + "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}" + } + ] + }, + { + "name": "Create a catalog integration.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"vXe6Je5s\",\n \"catalog\": {\n \"catalog_source\": \"GLUE\"\n },\n \"table_format\": \"ICEBERG\",\n \"enabled\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/catalog-integrations?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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 catalog integration." + }, + "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\": \"vXe6Je5s\",\n \"catalog\": {\n \"catalog_source\": \"GLUE\"\n },\n \"table_format\": \"ICEBERG\",\n \"enabled\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/catalog-integrations?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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\": \"vXe6Je5s\",\n \"catalog\": {\n \"catalog_source\": \"GLUE\"\n },\n \"table_format\": \"ICEBERG\",\n \"enabled\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/catalog-integrations?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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\": \"vXe6Je5s\",\n \"catalog\": {\n \"catalog_source\": \"GLUE\"\n },\n \"table_format\": \"ICEBERG\",\n \"enabled\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/catalog-integrations?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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\": \"vXe6Je5s\",\n \"catalog\": {\n \"catalog_source\": \"GLUE\"\n },\n \"table_format\": \"ICEBERG\",\n \"enabled\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/catalog-integrations?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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\": \"vXe6Je5s\",\n \"catalog\": {\n \"catalog_source\": \"GLUE\"\n },\n \"table_format\": \"ICEBERG\",\n \"enabled\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/catalog-integrations?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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\": \"vXe6Je5s\",\n \"catalog\": {\n \"catalog_source\": \"GLUE\"\n },\n \"table_format\": \"ICEBERG\",\n \"enabled\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/catalog-integrations?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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\": \"vXe6Je5s\",\n \"catalog\": {\n \"catalog_source\": \"GLUE\"\n },\n \"table_format\": \"ICEBERG\",\n \"enabled\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/catalog-integrations?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"vXe6Je5s\",\n \"catalog\": {\n \"catalog_source\": \"GLUE\"\n },\n \"table_format\": \"ICEBERG\",\n \"enabled\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/catalog-integrations?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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\": \"vXe6Je5s\",\n \"catalog\": {\n \"catalog_source\": \"GLUE\"\n },\n \"table_format\": \"ICEBERG\",\n \"enabled\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/catalog-integrations?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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\": \"vXe6Je5s\",\n \"catalog\": {\n \"catalog_source\": \"GLUE\"\n },\n \"table_format\": \"ICEBERG\",\n \"enabled\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/catalog-integrations?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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\": \"vXe6Je5s\",\n \"catalog\": {\n \"catalog_source\": \"GLUE\"\n },\n \"table_format\": \"ICEBERG\",\n \"enabled\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/catalog-integrations?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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\": \"vXe6Je5s\",\n \"catalog\": {\n \"catalog_source\": \"GLUE\"\n },\n \"table_format\": \"ICEBERG\",\n \"enabled\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/catalog-integrations?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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\": \"vXe6Je5s\",\n \"catalog\": {\n \"catalog_source\": \"GLUE\"\n },\n \"table_format\": \"ICEBERG\",\n \"enabled\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/catalog-integrations?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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\": \"vXe6Je5s\",\n \"catalog\": {\n \"catalog_source\": \"GLUE\"\n },\n \"table_format\": \"ICEBERG\",\n \"enabled\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/catalog-integrations?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "catalog-integrations" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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}" + } + ] + } + ] + } + ] + } + ] + } + ], + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + } + ] +} \ No newline at end of file diff --git a/releases/8.40/collections/Snowflake Compute Pools API.postman_collection.json b/releases/8.40/collections/Snowflake Compute Pools API.postman_collection.json new file mode 100644 index 0000000..369081c --- /dev/null +++ b/releases/8.40/collections/Snowflake Compute Pools API.postman_collection.json @@ -0,0 +1,6163 @@ +{ + "info": { + "_postman_id": "b24237a0-088d-4123-a2db-6b96f1b68f15", + "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" + }, + "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": "\"JSf:\"\"\"\"&\"\"\"", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"0\\\"\\\"\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"state\": \"RESIZING\",\n \"num_services\": \"\",\n \"num_jobs\": \"\",\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 \"is_exclusive\": \"\",\n \"application\": \"\",\n \"budget\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Create a (or alter an existing) compute pool.", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"6\\\"\\\"i\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"auto_suspend_secs\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "variable": [ + { + "key": "name", + "value": "\"JSf:\"\"\"\"&\"\"\"", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Create a (or alter an existing) compute pool. 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"6\\\"\\\"i\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"auto_suspend_secs\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "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 \"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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"6\\\"\\\"i\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"auto_suspend_secs\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "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": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"6\\\"\\\"i\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"auto_suspend_secs\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "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": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"6\\\"\\\"i\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"auto_suspend_secs\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "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": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"6\\\"\\\"i\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"auto_suspend_secs\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "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": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"6\\\"\\\"i\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"auto_suspend_secs\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "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": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"6\\\"\\\"i\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"auto_suspend_secs\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "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": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"6\\\"\\\"i\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"auto_suspend_secs\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "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": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"6\\\"\\\"i\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"auto_suspend_secs\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "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": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"6\\\"\\\"i\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"auto_suspend_secs\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "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": "\"JSf:\"\"\"\"&\"\"\"", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"\\\"\\\"\\\"F]sbA\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"state\": \"IDLE\",\n \"num_services\": \"\",\n \"num_jobs\": \"\",\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 \"is_exclusive\": \"\",\n \"application\": \"\",\n \"budget\": \"\",\n \"error_code\": \"\",\n \"status_message\": \"\"\n },\n {\n \"name\": \"x24K\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"state\": \"UNKNOWN\",\n \"num_services\": \"\",\n \"num_jobs\": \"\",\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 \"is_exclusive\": \"\",\n \"application\": \"\",\n \"budget\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"\\\"\\\"\\\"\\\"\\\"6\\\"\\\"i\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"auto_suspend_secs\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"6\\\"\\\"i\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"auto_suspend_secs\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"6\\\"\\\"i\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"auto_suspend_secs\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"6\\\"\\\"i\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"auto_suspend_secs\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"6\\\"\\\"i\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"auto_suspend_secs\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"6\\\"\\\"i\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"auto_suspend_secs\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"6\\\"\\\"i\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"auto_suspend_secs\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"6\\\"\\\"i\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"auto_suspend_secs\": \"\"\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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"6\\\"\\\"i\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"auto_suspend_secs\": \"\"\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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"6\\\"\\\"i\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"auto_suspend_secs\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"6\\\"\\\"i\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"auto_suspend_secs\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"6\\\"\\\"i\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"auto_suspend_secs\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"6\\\"\\\"i\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"auto_suspend_secs\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"6\\\"\\\"i\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"auto_suspend_secs\": \"\"\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}" + } + ] + } + ] + } + ] + } + ] + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + }, + { + "key": "name", + "value": "\"JSf:\"\"\"\"&\"\"\"" + } + ] +} \ No newline at end of file diff --git a/releases/8.40/collections/Snowflake Database API.postman_collection.json b/releases/8.40/collections/Snowflake Database API.postman_collection.json new file mode 100644 index 0000000..e260cba --- /dev/null +++ b/releases/8.40/collections/Snowflake Database API.postman_collection.json @@ -0,0 +1,14550 @@ +{ + "info": { + "_postman_id": "761a98fa-369a-4fbc-9096-0e96c9afadfc", + "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" + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"E_XG2nW3A2\",\n \"point_of_time\": {\n \"point_of_time_type\": \"irure mollit exercitation\",\n \"reference\": \"aute sunt\"\n },\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"E_XG2nW3A2\",\n \"point_of_time\": {\n \"point_of_time_type\": \"irure mollit exercitation\",\n \"reference\": \"aute sunt\"\n },\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"E_XG2nW3A2\",\n \"point_of_time\": {\n \"point_of_time_type\": \"irure mollit exercitation\",\n \"reference\": \"aute sunt\"\n },\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"E_XG2nW3A2\",\n \"point_of_time\": {\n \"point_of_time_type\": \"irure mollit exercitation\",\n \"reference\": \"aute sunt\"\n },\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"E_XG2nW3A2\",\n \"point_of_time\": {\n \"point_of_time_type\": \"irure mollit exercitation\",\n \"reference\": \"aute sunt\"\n },\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"E_XG2nW3A2\",\n \"point_of_time\": {\n \"point_of_time_type\": \"irure mollit exercitation\",\n \"reference\": \"aute sunt\"\n },\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"E_XG2nW3A2\",\n \"point_of_time\": {\n \"point_of_time_type\": \"irure mollit exercitation\",\n \"reference\": \"aute sunt\"\n },\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"E_XG2nW3A2\",\n \"point_of_time\": {\n \"point_of_time_type\": \"irure mollit exercitation\",\n \"reference\": \"aute sunt\"\n },\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"E_XG2nW3A2\",\n \"point_of_time\": {\n \"point_of_time_type\": \"irure mollit exercitation\",\n \"reference\": \"aute sunt\"\n },\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"E_XG2nW3A2\",\n \"point_of_time\": {\n \"point_of_time_type\": \"irure mollit exercitation\",\n \"reference\": \"aute sunt\"\n },\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"E_XG2nW3A2\",\n \"point_of_time\": {\n \"point_of_time_type\": \"irure mollit exercitation\",\n \"reference\": \"aute sunt\"\n },\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"E_XG2nW3A2\",\n \"point_of_time\": {\n \"point_of_time_type\": \"irure mollit exercitation\",\n \"reference\": \"aute sunt\"\n },\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"E_XG2nW3A2\",\n \"point_of_time\": {\n \"point_of_time_type\": \"irure mollit exercitation\",\n \"reference\": \"aute sunt\"\n },\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"E_XG2nW3A2\",\n \"point_of_time\": {\n \"point_of_time_type\": \"irure mollit exercitation\",\n \"reference\": \"aute sunt\"\n },\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"E_XG2nW3A2\",\n \"point_of_time\": {\n \"point_of_time_type\": \"irure mollit exercitation\",\n \"reference\": \"aute sunt\"\n },\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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": "OYnT", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "OYnT", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "OYnT", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/replication:refresh", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "replication:refresh" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "OYnT", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "OYnT", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "OYnT", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name/failover:primary", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name", + "failover:primary" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "OYnT", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"name\": \"RQgGEE94IK\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"\\\"]E\\\"\\\"\\\"\\\"4\\\\l-\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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": "OYnT", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"]E\\\"\\\"\\\"\\\"4\\\\l-\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"]E\\\"\\\"\\\"\\\"4\\\\l-\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"]E\\\"\\\"\\\"\\\"4\\\\l-\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"]E\\\"\\\"\\\"\\\"4\\\\l-\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"]E\\\"\\\"\\\"\\\"4\\\\l-\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"]E\\\"\\\"\\\"\\\"4\\\\l-\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"]E\\\"\\\"\\\"\\\"4\\\\l-\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"]E\\\"\\\"\\\"\\\"4\\\\l-\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"]E\\\"\\\"\\\"\\\"4\\\\l-\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"]E\\\"\\\"\\\"\\\"4\\\\l-\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"]E\\\"\\\"\\\"\\\"4\\\\l-\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"]E\\\"\\\"\\\"\\\"4\\\\l-\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"]E\\\"\\\"\\\"\\\"4\\\\l-\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"]E\\\"\\\"\\\"\\\"4\\\\l-\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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": "OYnT", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "{name}:undrop", + "item": [ + { + "name": "Undrop a database.", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:undrop" + ] + }, + "description": "Undrops database." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:undrop" + ] + } + }, + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:undrop" + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"LG\",\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\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"\\\"]E\\\"\\\"\\\"\\\"4\\\\l-\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"]E\\\"\\\"\\\"\\\"4\\\\l-\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"]E\\\"\\\"\\\"\\\"4\\\\l-\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"]E\\\"\\\"\\\"\\\"4\\\\l-\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"]E\\\"\\\"\\\"\\\"4\\\\l-\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"]E\\\"\\\"\\\"\\\"4\\\\l-\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"]E\\\"\\\"\\\"\\\"4\\\\l-\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"]E\\\"\\\"\\\"\\\"4\\\\l-\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"]E\\\"\\\"\\\"\\\"4\\\\l-\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"]E\\\"\\\"\\\"\\\"4\\\\l-\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"]E\\\"\\\"\\\"\\\"4\\\\l-\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"]E\\\"\\\"\\\"\\\"4\\\\l-\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"]E\\\"\\\"\\\"\\\"4\\\\l-\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"]E\\\"\\\"\\\"\\\"4\\\\l-\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"]E\\\"\\\"\\\"\\\"4\\\\l-\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\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\": \"\\\"\\\"\\\"\\\"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\"\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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\"\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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\"\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}" + } + ] + } + ] + } + ] + } + ] + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + }, + { + "key": "name", + "value": "OYnT" + } + ] +} \ No newline at end of file diff --git a/releases/8.40/collections/Snowflake Database Role API.postman_collection.json b/releases/8.40/collections/Snowflake Database Role API.postman_collection.json new file mode 100644 index 0000000..6bef030 --- /dev/null +++ b/releases/8.40/collections/Snowflake Database Role API.postman_collection.json @@ -0,0 +1,10889 @@ +{ + "info": { + "_postman_id": "ad2d4dc8-a26d-41a4-9da7-d178472240a1", + "name": "Snowflake Database Role API", + "description": "The Snowflake Database Role API is a REST API that you can use to access, update, and perform certain actions on Database Role 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" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "databases", + "item": [ + { + "name": "{database}", + "item": [ + { + "name": "database-roles", + "item": [ + { + "name": "{name}", + "item": [ + { + "name": "grants", + "item": [ + { + "name": "List all grants to the role", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "variable": [ + { + "key": "database", + "value": "bGUu5NsZL", + "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": "bGUu5NsZL", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "List all grants to the role" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r7lrZhei\",\n \"database\": \"\\\"~E&\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\",O\\\"\\\"\\\"\\\";Yv\\\"\\\"X\\\"\",\n \"service\": \"\\\"\\\"\\\"9\\\"\\\"W}+\\\"\\\"\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"so\",\n \"schema\": \"\\\"p\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"created_on\": \"\",\n \"granted_by\": \"\"\n },\n {\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"BEikLURisw$\",\n \"database\": \"\\\"\\\"\\\"C7\\\"\\\"f\\\"\",\n \"schema\": \"pAU5R\",\n \"service\": \"\\\"?%-M~\\\"\\\"G2j\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"Q\\\"\\\"\\\"\\\",k\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"created_on\": \"\",\n \"granted_by\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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": "Grant privileges to the role", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants" + ], + "variable": [ + { + "key": "database", + "value": "bGUu5NsZL", + "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": "bGUu5NsZL", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Grant privileges to the role" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants" + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants" + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants" + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants" + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants" + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants" + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants" + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants" + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants" + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants" + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants" + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants" + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants" + ], + "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": "grants:revoke", + "item": [ + { + "name": "Revoke grants from the role", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants:revoke?mode=cascade", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "cascade", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "variable": [ + { + "key": "database", + "value": "bGUu5NsZL", + "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": "bGUu5NsZL", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Revoke grants from the role" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants:revoke?mode=cascade", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "cascade", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants:revoke?mode=cascade", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "cascade", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants:revoke?mode=cascade", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "cascade", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants:revoke?mode=cascade", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "cascade", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants:revoke?mode=cascade", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "cascade", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants:revoke?mode=cascade", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "cascade", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants:revoke?mode=cascade", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "cascade", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants:revoke?mode=cascade", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "cascade", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants:revoke?mode=cascade", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "cascade", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants:revoke?mode=cascade", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "cascade", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants:revoke?mode=cascade", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "cascade", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants:revoke?mode=cascade", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "cascade", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants:revoke?mode=cascade", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "cascade", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/grants:revoke?mode=cascade", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "cascade", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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": "future-grants", + "item": [ + { + "name": "List all future grants to the role", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "variable": [ + { + "key": "database", + "value": "bGUu5NsZL", + "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": "bGUu5NsZL", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "List all future grants to the role" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r7lrZhei\",\n \"database\": \"\\\"~E&\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\",O\\\"\\\"\\\"\\\";Yv\\\"\\\"X\\\"\",\n \"service\": \"\\\"\\\"\\\"9\\\"\\\"W}+\\\"\\\"\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"so\",\n \"schema\": \"\\\"p\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"created_on\": \"\",\n \"granted_by\": \"\"\n },\n {\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"BEikLURisw$\",\n \"database\": \"\\\"\\\"\\\"C7\\\"\\\"f\\\"\",\n \"schema\": \"pAU5R\",\n \"service\": \"\\\"?%-M~\\\"\\\"G2j\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"Q\\\"\\\"\\\"\\\",k\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"created_on\": \"\",\n \"granted_by\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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": "Grant future privileges to the role", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants" + ], + "variable": [ + { + "key": "database", + "value": "bGUu5NsZL", + "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": "bGUu5NsZL", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Grant future privileges to the role" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants" + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants" + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants" + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants" + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants" + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants" + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants" + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants" + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants" + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants" + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants" + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants" + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants" + ], + "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": "future-grants:revoke", + "item": [ + { + "name": "Revoke future grants from the role", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants:revoke?mode=cascade", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "cascade", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "variable": [ + { + "key": "database", + "value": "bGUu5NsZL", + "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": "bGUu5NsZL", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Revoke future grants from the role" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants:revoke?mode=cascade", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "cascade", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants:revoke?mode=cascade", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "cascade", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants:revoke?mode=cascade", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "cascade", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants:revoke?mode=cascade", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "cascade", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants:revoke?mode=cascade", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "cascade", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants:revoke?mode=cascade", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "cascade", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants:revoke?mode=cascade", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "cascade", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants:revoke?mode=cascade", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "cascade", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants:revoke?mode=cascade", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "cascade", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants:revoke?mode=cascade", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "cascade", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants:revoke?mode=cascade", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "cascade", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants:revoke?mode=cascade", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "cascade", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants:revoke?mode=cascade", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "cascade", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"r_Nt\",\n \"database\": \"_eHY_w8xyvi\",\n \"schema\": \"\\\"q[3\\\"\\\">)I]#8b\\\"\",\n \"service\": \"\\\"E;;\\\"\\\"Y\\\"\\\"C\\\"\\\"\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\">[\\\"\\\"F\\\"\",\n \"schema\": \"\\\"Mo*c\\\"\\\"e\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name/future-grants:revoke?mode=cascade", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + ":name", + "future-grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "cascade", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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": "Delete a database role", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-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": "database", + "value": "bGUu5NsZL", + "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": "bGUu5NsZL", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Delete a database role" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-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": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-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": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-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": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-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": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-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": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-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": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-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": "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-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": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-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": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-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": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-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": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-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": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-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": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-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": "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": "{name}:clone", + "item": [ + { + "name": "Create a new database role by cloning from the specified resource", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"DCzUm\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/{{name}}:clone?createMode=errorIfExists&targetDatabase=R", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + "{{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": "targetDatabase", + "value": "R", + "description": "Database of the target resource. Defaults to the source's database" + } + ], + "variable": [ + { + "key": "database", + "value": "bGUu5NsZL", + "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": "Create a new database role 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"DCzUm\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/{{name}}:clone?createMode=errorIfExists&targetDatabase=R", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + "{{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": "targetDatabase", + "value": "R", + "description": "Database of the target resource. Defaults to the source'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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"DCzUm\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/{{name}}:clone?createMode=errorIfExists&targetDatabase=R", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + "{{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": "targetDatabase", + "value": "R", + "description": "Database of the target resource. Defaults to the source'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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"DCzUm\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/{{name}}:clone?createMode=errorIfExists&targetDatabase=R", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + "{{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": "targetDatabase", + "value": "R", + "description": "Database of the target resource. Defaults to the source'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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"DCzUm\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/{{name}}:clone?createMode=errorIfExists&targetDatabase=R", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + "{{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": "targetDatabase", + "value": "R", + "description": "Database of the target resource. Defaults to the source'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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"DCzUm\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/{{name}}:clone?createMode=errorIfExists&targetDatabase=R", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + "{{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": "targetDatabase", + "value": "R", + "description": "Database of the target resource. Defaults to the source'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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"DCzUm\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/{{name}}:clone?createMode=errorIfExists&targetDatabase=R", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + "{{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": "targetDatabase", + "value": "R", + "description": "Database of the target resource. Defaults to the source'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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"DCzUm\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/{{name}}:clone?createMode=errorIfExists&targetDatabase=R", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + "{{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": "targetDatabase", + "value": "R", + "description": "Database of the target resource. Defaults to the source'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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"DCzUm\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/{{name}}:clone?createMode=errorIfExists&targetDatabase=R", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + "{{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": "targetDatabase", + "value": "R", + "description": "Database of the target resource. Defaults to the source's database" + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"DCzUm\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/{{name}}:clone?createMode=errorIfExists&targetDatabase=R", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + "{{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": "targetDatabase", + "value": "R", + "description": "Database of the target resource. Defaults to the source'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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"DCzUm\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/{{name}}:clone?createMode=errorIfExists&targetDatabase=R", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + "{{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": "targetDatabase", + "value": "R", + "description": "Database of the target resource. Defaults to the source'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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"DCzUm\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/{{name}}:clone?createMode=errorIfExists&targetDatabase=R", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + "{{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": "targetDatabase", + "value": "R", + "description": "Database of the target resource. Defaults to the source'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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"DCzUm\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/{{name}}:clone?createMode=errorIfExists&targetDatabase=R", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + "{{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": "targetDatabase", + "value": "R", + "description": "Database of the target resource. Defaults to the source'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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"DCzUm\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/{{name}}:clone?createMode=errorIfExists&targetDatabase=R", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + "{{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": "targetDatabase", + "value": "R", + "description": "Database of the target resource. Defaults to the source'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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"DCzUm\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles/{{name}}:clone?createMode=errorIfExists&targetDatabase=R", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles", + "{{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": "targetDatabase", + "value": "R", + "description": "Database of the target resource. Defaults to the source'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": "List database roles", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles?showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles" + ], + "query": [ + { + "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": "bGUu5NsZL", + "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": "List database roles" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles?showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles" + ], + "query": [ + { + "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" + } + ] + } + }, + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"O$xPH1VpEV\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"granted_to_roles\": \"\",\n \"granted_to_database_roles\": \"\",\n \"granted_database_roles\": \"\",\n \"owner\": \"\\\"\\\"\\\"wQr]bv\\\"\\\"\\\"\",\n \"owner_role_type\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"6*Igxo\\\"\"\n },\n {\n \"name\": \"U9r4g\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"granted_to_roles\": \"\",\n \"granted_to_database_roles\": \"\",\n \"granted_database_roles\": \"\",\n \"owner\": \"D$x1AF\",\n \"owner_role_type\": \"BkFMM4Spi2u\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles?showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles" + ], + "query": [ + { + "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" + } + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles?showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles" + ], + "query": [ + { + "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" + } + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles?showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles" + ], + "query": [ + { + "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" + } + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles?showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles" + ], + "query": [ + { + "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" + } + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles?showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles" + ], + "query": [ + { + "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" + } + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles?showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles" + ], + "query": [ + { + "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" + } + ] + } + }, + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles?showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles" + ], + "query": [ + { + "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" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles?showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles" + ], + "query": [ + { + "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" + } + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles?showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles" + ], + "query": [ + { + "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" + } + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles?showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles" + ], + "query": [ + { + "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" + } + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles?showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles" + ], + "query": [ + { + "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" + } + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles?showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles" + ], + "query": [ + { + "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" + } + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles?showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-roles" + ], + "query": [ + { + "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" + } + ] + } + }, + "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 database role", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"imG0Xo\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-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." + } + ], + "variable": [ + { + "key": "database", + "value": "bGUu5NsZL", + "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": "Create a database role" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"imG0Xo\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-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." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"imG0Xo\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-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." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"imG0Xo\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-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." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"imG0Xo\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-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." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"imG0Xo\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-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." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"imG0Xo\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-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." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"imG0Xo\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-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." + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"imG0Xo\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-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." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"imG0Xo\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-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." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"imG0Xo\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-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." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"imG0Xo\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-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." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"imG0Xo\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-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." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"imG0Xo\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-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." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"imG0Xo\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/database-roles?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "database-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." + } + ], + "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}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + }, + { + "key": "name", + "value": "bGUu5NsZL" + } + ] +} \ No newline at end of file diff --git a/releases/8.40/collections/Snowflake Dynamic Table API.postman_collection.json b/releases/8.40/collections/Snowflake Dynamic Table API.postman_collection.json new file mode 100644 index 0000000..4b7e6bf --- /dev/null +++ b/releases/8.40/collections/Snowflake Dynamic Table API.postman_collection.json @@ -0,0 +1,13103 @@ +{ + "info": { + "_postman_id": "b076c4a3-dc72-4bee-9494-865aad1eb8da", + "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" + }, + "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": "eVUO", + "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": "eVUO", + "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": "eVUO", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "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_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\": \"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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "eVUO", + "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": "eVUO", + "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": "eVUO", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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=eVUO&targetSchema=eVUO", + "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": "eVUO", + "description": "Database of the newly created dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "eVUO", + "description": "Schema of the newly created dynamic table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database", + "value": "eVUO", + "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": "eVUO", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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=eVUO&targetSchema=eVUO", + "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": "eVUO", + "description": "Database of the newly created dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "eVUO", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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=eVUO&targetSchema=eVUO", + "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": "eVUO", + "description": "Database of the newly created dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "eVUO", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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=eVUO&targetSchema=eVUO", + "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": "eVUO", + "description": "Database of the newly created dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "eVUO", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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=eVUO&targetSchema=eVUO", + "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": "eVUO", + "description": "Database of the newly created dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "eVUO", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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=eVUO&targetSchema=eVUO", + "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": "eVUO", + "description": "Database of the newly created dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "eVUO", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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=eVUO&targetSchema=eVUO", + "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": "eVUO", + "description": "Database of the newly created dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "eVUO", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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=eVUO&targetSchema=eVUO", + "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": "eVUO", + "description": "Database of the newly created dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "eVUO", + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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=eVUO&targetSchema=eVUO", + "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": "eVUO", + "description": "Database of the newly created dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "eVUO", + "description": "Schema of the newly created dynamic table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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=eVUO&targetSchema=eVUO", + "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": "eVUO", + "description": "Database of the newly created dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "eVUO", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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=eVUO&targetSchema=eVUO", + "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": "eVUO", + "description": "Database of the newly created dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "eVUO", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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=eVUO&targetSchema=eVUO", + "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": "eVUO", + "description": "Database of the newly created dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "eVUO", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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=eVUO&targetSchema=eVUO", + "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": "eVUO", + "description": "Database of the newly created dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "eVUO", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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=eVUO&targetSchema=eVUO", + "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": "eVUO", + "description": "Database of the newly created dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "eVUO", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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=eVUO&targetSchema=eVUO", + "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": "eVUO", + "description": "Database of the newly created dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "eVUO", + "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": "eVUO", + "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": "eVUO", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "eVUO", + "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": "eVUO", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "eVUO", + "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": "eVUO", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "eVUO", + "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": "eVUO", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "eVUO", + "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": "eVUO", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "eVUO", + "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": "eVUO", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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=eVUO&targetDatabase=eVUO&targetSchema=eVUO", + "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": "eVUO", + "description": "(Required) The name of the target dynamic table to be swapped with." + }, + { + "key": "targetDatabase", + "value": "eVUO", + "description": "Database of the target dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "eVUO", + "description": "Schema of the target dynamic table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database", + "value": "eVUO", + "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": "eVUO", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:swap-with?ifExists=false&targetName=eVUO&targetDatabase=eVUO&targetSchema=eVUO", + "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": "eVUO", + "description": "(Required) The name of the target dynamic table to be swapped with." + }, + { + "key": "targetDatabase", + "value": "eVUO", + "description": "Database of the target dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "eVUO", + "description": "Schema of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:swap-with?ifExists=false&targetName=eVUO&targetDatabase=eVUO&targetSchema=eVUO", + "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": "eVUO", + "description": "(Required) The name of the target dynamic table to be swapped with." + }, + { + "key": "targetDatabase", + "value": "eVUO", + "description": "Database of the target dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "eVUO", + "description": "Schema of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:swap-with?ifExists=false&targetName=eVUO&targetDatabase=eVUO&targetSchema=eVUO", + "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": "eVUO", + "description": "(Required) The name of the target dynamic table to be swapped with." + }, + { + "key": "targetDatabase", + "value": "eVUO", + "description": "Database of the target dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "eVUO", + "description": "Schema of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:swap-with?ifExists=false&targetName=eVUO&targetDatabase=eVUO&targetSchema=eVUO", + "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": "eVUO", + "description": "(Required) The name of the target dynamic table to be swapped with." + }, + { + "key": "targetDatabase", + "value": "eVUO", + "description": "Database of the target dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "eVUO", + "description": "Schema of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:swap-with?ifExists=false&targetName=eVUO&targetDatabase=eVUO&targetSchema=eVUO", + "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": "eVUO", + "description": "(Required) The name of the target dynamic table to be swapped with." + }, + { + "key": "targetDatabase", + "value": "eVUO", + "description": "Database of the target dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "eVUO", + "description": "Schema of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:swap-with?ifExists=false&targetName=eVUO&targetDatabase=eVUO&targetSchema=eVUO", + "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": "eVUO", + "description": "(Required) The name of the target dynamic table to be swapped with." + }, + { + "key": "targetDatabase", + "value": "eVUO", + "description": "Database of the target dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "eVUO", + "description": "Schema of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:swap-with?ifExists=false&targetName=eVUO&targetDatabase=eVUO&targetSchema=eVUO", + "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": "eVUO", + "description": "(Required) The name of the target dynamic table to be swapped with." + }, + { + "key": "targetDatabase", + "value": "eVUO", + "description": "Database of the target dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "eVUO", + "description": "Schema of the target 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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:swap-with?ifExists=false&targetName=eVUO&targetDatabase=eVUO&targetSchema=eVUO", + "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": "eVUO", + "description": "(Required) The name of the target dynamic table to be swapped with." + }, + { + "key": "targetDatabase", + "value": "eVUO", + "description": "Database of the target dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "eVUO", + "description": "Schema of the target dynamic table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:swap-with?ifExists=false&targetName=eVUO&targetDatabase=eVUO&targetSchema=eVUO", + "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": "eVUO", + "description": "(Required) The name of the target dynamic table to be swapped with." + }, + { + "key": "targetDatabase", + "value": "eVUO", + "description": "Database of the target dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "eVUO", + "description": "Schema of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:swap-with?ifExists=false&targetName=eVUO&targetDatabase=eVUO&targetSchema=eVUO", + "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": "eVUO", + "description": "(Required) The name of the target dynamic table to be swapped with." + }, + { + "key": "targetDatabase", + "value": "eVUO", + "description": "Database of the target dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "eVUO", + "description": "Schema of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:swap-with?ifExists=false&targetName=eVUO&targetDatabase=eVUO&targetSchema=eVUO", + "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": "eVUO", + "description": "(Required) The name of the target dynamic table to be swapped with." + }, + { + "key": "targetDatabase", + "value": "eVUO", + "description": "Database of the target dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "eVUO", + "description": "Schema of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:swap-with?ifExists=false&targetName=eVUO&targetDatabase=eVUO&targetSchema=eVUO", + "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": "eVUO", + "description": "(Required) The name of the target dynamic table to be swapped with." + }, + { + "key": "targetDatabase", + "value": "eVUO", + "description": "Database of the target dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "eVUO", + "description": "Schema of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:swap-with?ifExists=false&targetName=eVUO&targetDatabase=eVUO&targetSchema=eVUO", + "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": "eVUO", + "description": "(Required) The name of the target dynamic table to be swapped with." + }, + { + "key": "targetDatabase", + "value": "eVUO", + "description": "Database of the target dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "eVUO", + "description": "Schema of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/dynamic-tables/{{name}}:swap-with?ifExists=false&targetName=eVUO&targetDatabase=eVUO&targetSchema=eVUO", + "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": "eVUO", + "description": "(Required) The name of the target dynamic table to be swapped with." + }, + { + "key": "targetDatabase", + "value": "eVUO", + "description": "Database of the target dynamic table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "eVUO", + "description": "Schema of the target 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": "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": "eVUO", + "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": "eVUO", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "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\": \"RUNNING\",\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\": \"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\": \"SUSPENDED\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"AUTO\",\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}", + "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": "eVUO", + "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": "eVUO", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"AUTO\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"AUTO\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"AUTO\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"AUTO\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"AUTO\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"AUTO\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"AUTO\",\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}", + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"AUTO\",\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}", + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"AUTO\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"AUTO\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"AUTO\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"AUTO\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"AUTO\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"AUTO\",\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}", + "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}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + }, + { + "key": "name", + "value": "eVUO" + } + ] +} \ No newline at end of file diff --git a/releases/8.40/collections/Snowflake Event Table API.postman_collection.json b/releases/8.40/collections/Snowflake Event Table API.postman_collection.json new file mode 100644 index 0000000..38a2a39 --- /dev/null +++ b/releases/8.40/collections/Snowflake Event Table API.postman_collection.json @@ -0,0 +1,5600 @@ +{ + "info": { + "_postman_id": "9c9d6fbb-a1ab-43a1-a27e-865fd7e24350", + "name": "Snowflake Event Table API", + "description": "The Snowflake Event Table API is a REST API that you can use to access, update, and perform certain actions on Event Table 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" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "databases", + "item": [ + { + "name": "{database}", + "item": [ + { + "name": "schemas", + "item": [ + { + "name": "{schema}", + "item": [ + { + "name": "event-tables", + "item": [ + { + "name": "{name}", + "item": [ + { + "name": "Fetch an event table", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-tables", + ":name" + ], + "variable": [ + { + "key": "database", + "value": "\"t?\"", + "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": "\"t?\"", + "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": "\"t?\"", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Fetch an event table" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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 \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"change_tracking\": \"\",\n \"default_ddl_collation\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": \"\",\n \"default\": \"\",\n \"primary_key\": \"\",\n \"unique_key\": \"\",\n \"check\": \"\",\n \"expression\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": \"\",\n \"default\": \"\",\n \"primary_key\": \"\",\n \"unique_key\": \"\",\n \"check\": \"\",\n \"expression\": \"\",\n \"comment\": \"\"\n }\n ]\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-tables", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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 an event table", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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": "\"t?\"", + "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": "\"t?\"", + "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": "\"t?\"", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Delete an event table" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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}:rename", + "item": [ + { + "name": "Rename the event table", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/{{name}}:rename?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-tables", + "{{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." + }, + { + "key": "targetName", + "value": "", + "description": "(Required) Specify the name of the target resource to be renamed to." + } + ], + "variable": [ + { + "key": "database", + "value": "\"t?\"", + "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": "\"t?\"", + "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": "Rename the event table" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/{{name}}:rename?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-tables", + "{{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." + }, + { + "key": "targetName", + "value": "", + "description": "(Required) Specify the name of the target resource to be renamed to." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/{{name}}:rename?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-tables", + "{{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." + }, + { + "key": "targetName", + "value": "", + "description": "(Required) Specify the name of the target resource to be renamed to." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/{{name}}:rename?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-tables", + "{{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." + }, + { + "key": "targetName", + "value": "", + "description": "(Required) Specify the name of the target resource to be renamed to." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/{{name}}:rename?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-tables", + "{{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." + }, + { + "key": "targetName", + "value": "", + "description": "(Required) Specify the name of the target resource to be renamed to." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/{{name}}:rename?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-tables", + "{{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." + }, + { + "key": "targetName", + "value": "", + "description": "(Required) Specify the name of the target resource to be renamed to." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/{{name}}:rename?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-tables", + "{{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." + }, + { + "key": "targetName", + "value": "", + "description": "(Required) Specify the name of the target resource to be renamed to." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/{{name}}:rename?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-tables", + "{{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." + }, + { + "key": "targetName", + "value": "", + "description": "(Required) Specify the name of the target resource to be renamed to." + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/{{name}}:rename?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-tables", + "{{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." + }, + { + "key": "targetName", + "value": "", + "description": "(Required) Specify the name of the target resource to be renamed to." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/{{name}}:rename?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-tables", + "{{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." + }, + { + "key": "targetName", + "value": "", + "description": "(Required) Specify the name of the target resource to be renamed to." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/{{name}}:rename?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-tables", + "{{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." + }, + { + "key": "targetName", + "value": "", + "description": "(Required) Specify the name of the target resource to be renamed to." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/{{name}}:rename?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-tables", + "{{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." + }, + { + "key": "targetName", + "value": "", + "description": "(Required) Specify the name of the target resource to be renamed to." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/{{name}}:rename?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-tables", + "{{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." + }, + { + "key": "targetName", + "value": "", + "description": "(Required) Specify the name of the target resource to be renamed to." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/{{name}}:rename?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-tables", + "{{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." + }, + { + "key": "targetName", + "value": "", + "description": "(Required) Specify the name of the target resource to be renamed to." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables/{{name}}:rename?ifExists=false&targetName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-tables", + "{{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." + }, + { + "key": "targetName", + "value": "", + "description": "(Required) Specify the name of the target resource to be renamed to." + } + ], + "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 event tables", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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." + } + ], + "variable": [ + { + "key": "database", + "value": "\"t?\"", + "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": "\"t?\"", + "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": "List event tables" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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." + } + ], + "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 \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"change_tracking\": \"\",\n \"default_ddl_collation\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": \"\",\n \"default\": \"\",\n \"primary_key\": \"\",\n \"unique_key\": \"\",\n \"check\": \"\",\n \"expression\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": \"\",\n \"default\": \"\",\n \"primary_key\": \"\",\n \"unique_key\": \"\",\n \"check\": \"\",\n \"expression\": \"\",\n \"comment\": \"\"\n }\n ]\n },\n {\n \"name\": \"\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"change_tracking\": \"\",\n \"default_ddl_collation\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"rows\": \"\",\n \"bytes\": \"\",\n \"automatic_clustering\": \"\",\n \"search_optimization\": \"\",\n \"search_optimization_progress\": \"\",\n \"search_optimization_bytes\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": \"\",\n \"default\": \"\",\n \"primary_key\": \"\",\n \"unique_key\": \"\",\n \"check\": \"\",\n \"expression\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"datatype\": \"\",\n \"nullable\": \"\",\n \"default\": \"\",\n \"primary_key\": \"\",\n \"unique_key\": \"\",\n \"check\": \"\",\n \"expression\": \"\",\n \"comment\": \"\"\n }\n ]\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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." + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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." + } + ], + "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 an event table", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"change_tracking\": \"\",\n \"default_ddl_collation\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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": "\"t?\"", + "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": "\"t?\"", + "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 an event table" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"change_tracking\": \"\",\n \"default_ddl_collation\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"change_tracking\": \"\",\n \"default_ddl_collation\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"change_tracking\": \"\",\n \"default_ddl_collation\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"change_tracking\": \"\",\n \"default_ddl_collation\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"change_tracking\": \"\",\n \"default_ddl_collation\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"change_tracking\": \"\",\n \"default_ddl_collation\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"change_tracking\": \"\",\n \"default_ddl_collation\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"change_tracking\": \"\",\n \"default_ddl_collation\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"change_tracking\": \"\",\n \"default_ddl_collation\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"change_tracking\": \"\",\n \"default_ddl_collation\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"change_tracking\": \"\",\n \"default_ddl_collation\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"change_tracking\": \"\",\n \"default_ddl_collation\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"change_tracking\": \"\",\n \"default_ddl_collation\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"cluster_by\": [\n \"\",\n \"\"\n ],\n \"data_retention_time_in_days\": \"\",\n \"max_data_extension_time_in_days\": \"\",\n \"change_tracking\": \"\",\n \"default_ddl_collation\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/event-tables?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "event-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}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + }, + { + "key": "name", + "value": "\"t?\"" + } + ] +} \ No newline at end of file diff --git a/releases/8.40/collections/Snowflake External Volume API.postman_collection.json b/releases/8.40/collections/Snowflake External Volume API.postman_collection.json new file mode 100644 index 0000000..7f8f008 --- /dev/null +++ b/releases/8.40/collections/Snowflake External Volume API.postman_collection.json @@ -0,0 +1,4256 @@ +{ + "info": { + "_postman_id": "b35e53b4-c13b-4979-8e68-57250538dc27", + "name": "Snowflake External Volume API", + "description": "The Snowflake External Volume API is a REST API that you can use to access, update, and perform certain actions on External Volume 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" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "external-volumes", + "item": [ + { + "name": "{name}", + "item": [ + { + "name": "Fetch an external volume", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + ":name" + ], + "variable": [ + { + "key": "name", + "value": "sMNKHpOs", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Fetch an external volume" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + ":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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"name\": \"\\\"\\\"\\\"Nq\\\"\",\n \"storage_locations\": [\n {\n \"name\": \"\",\n \"storage_provider\": \"GCS\"\n },\n {\n \"name\": \"\",\n \"storage_provider\": \"S3GOV\"\n }\n ],\n \"allow_writes\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"owner\": \"vH4vLi\",\n \"owner_role_type\": \"\\\"\\\"\\\"'6\\\"\\\"\\\"\\\"|\\\"\\\"\\\"\\\"+\\\"\\\"\\\"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + ":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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + ":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 an external volume", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + ":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": "sMNKHpOs", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Delete an external volume" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + ":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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + ":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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + ":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}:undrop", + "item": [ + { + "name": "Undrop an external volume", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + "{{name}}:undrop" + ] + }, + "description": "Undrop an external volume" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + "{{name}}:undrop" + ] + } + }, + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + "{{name}}:undrop" + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + "{{name}}:undrop" + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes", + "{{name}}:undrop" + ] + } + }, + "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 external volumes", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes" + ], + "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": "List external volumes" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes" + ], + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"nZ3\",\n \"storage_locations\": [\n {\n \"name\": \"\",\n \"storage_provider\": \"AZURE\"\n },\n {\n \"name\": \"\",\n \"storage_provider\": \"S3\"\n }\n ],\n \"allow_writes\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"owner\": \"\\\",jrrP\\\"\\\"\\\"\\\"\\\"\",\n \"owner_role_type\": \"n$tGi1Q0\"\n },\n {\n \"name\": \"\\\"RYrnA\\\"\",\n \"storage_locations\": [\n {\n \"name\": \"\",\n \"storage_provider\": \"S3\"\n },\n {\n \"name\": \"\",\n \"storage_provider\": \"S3\"\n }\n ],\n \"allow_writes\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"owner\": \"\\\"\\\"\\\"o\\\"\\\"h\\\"\",\n \"owner_role_type\": \"SFQQ\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes" + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes" + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes" + ], + "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}" + } + ] + }, + { + "name": "Create an external volume", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Y\",\n \"storage_locations\": [\n {\n \"name\": \"\",\n \"storage_provider\": \"GCS\"\n },\n {\n \"name\": \"\",\n \"storage_provider\": \"GCS\"\n }\n ],\n \"allow_writes\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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 an external volume" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Y\",\n \"storage_locations\": [\n {\n \"name\": \"\",\n \"storage_provider\": \"GCS\"\n },\n {\n \"name\": \"\",\n \"storage_provider\": \"GCS\"\n }\n ],\n \"allow_writes\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Y\",\n \"storage_locations\": [\n {\n \"name\": \"\",\n \"storage_provider\": \"GCS\"\n },\n {\n \"name\": \"\",\n \"storage_provider\": \"GCS\"\n }\n ],\n \"allow_writes\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Y\",\n \"storage_locations\": [\n {\n \"name\": \"\",\n \"storage_provider\": \"GCS\"\n },\n {\n \"name\": \"\",\n \"storage_provider\": \"GCS\"\n }\n ],\n \"allow_writes\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Y\",\n \"storage_locations\": [\n {\n \"name\": \"\",\n \"storage_provider\": \"GCS\"\n },\n {\n \"name\": \"\",\n \"storage_provider\": \"GCS\"\n }\n ],\n \"allow_writes\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Y\",\n \"storage_locations\": [\n {\n \"name\": \"\",\n \"storage_provider\": \"GCS\"\n },\n {\n \"name\": \"\",\n \"storage_provider\": \"GCS\"\n }\n ],\n \"allow_writes\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Y\",\n \"storage_locations\": [\n {\n \"name\": \"\",\n \"storage_provider\": \"GCS\"\n },\n {\n \"name\": \"\",\n \"storage_provider\": \"GCS\"\n }\n ],\n \"allow_writes\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Y\",\n \"storage_locations\": [\n {\n \"name\": \"\",\n \"storage_provider\": \"GCS\"\n },\n {\n \"name\": \"\",\n \"storage_provider\": \"GCS\"\n }\n ],\n \"allow_writes\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Y\",\n \"storage_locations\": [\n {\n \"name\": \"\",\n \"storage_provider\": \"GCS\"\n },\n {\n \"name\": \"\",\n \"storage_provider\": \"GCS\"\n }\n ],\n \"allow_writes\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Y\",\n \"storage_locations\": [\n {\n \"name\": \"\",\n \"storage_provider\": \"GCS\"\n },\n {\n \"name\": \"\",\n \"storage_provider\": \"GCS\"\n }\n ],\n \"allow_writes\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Y\",\n \"storage_locations\": [\n {\n \"name\": \"\",\n \"storage_provider\": \"GCS\"\n },\n {\n \"name\": \"\",\n \"storage_provider\": \"GCS\"\n }\n ],\n \"allow_writes\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Y\",\n \"storage_locations\": [\n {\n \"name\": \"\",\n \"storage_provider\": \"GCS\"\n },\n {\n \"name\": \"\",\n \"storage_provider\": \"GCS\"\n }\n ],\n \"allow_writes\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Y\",\n \"storage_locations\": [\n {\n \"name\": \"\",\n \"storage_provider\": \"GCS\"\n },\n {\n \"name\": \"\",\n \"storage_provider\": \"GCS\"\n }\n ],\n \"allow_writes\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Y\",\n \"storage_locations\": [\n {\n \"name\": \"\",\n \"storage_provider\": \"GCS\"\n },\n {\n \"name\": \"\",\n \"storage_provider\": \"GCS\"\n }\n ],\n \"allow_writes\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"Y\",\n \"storage_locations\": [\n {\n \"name\": \"\",\n \"storage_provider\": \"GCS\"\n },\n {\n \"name\": \"\",\n \"storage_provider\": \"GCS\"\n }\n ],\n \"allow_writes\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/external-volumes?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "external-volumes" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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}" + } + ] + } + ] + } + ] + } + ] + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + }, + { + "key": "name", + "value": "sMNKHpOs" + } + ] +} \ No newline at end of file diff --git a/releases/8.40/collections/Snowflake Function API.postman_collection.json b/releases/8.40/collections/Snowflake Function API.postman_collection.json new file mode 100644 index 0000000..6187d36 --- /dev/null +++ b/releases/8.40/collections/Snowflake Function API.postman_collection.json @@ -0,0 +1,4447 @@ +{ + "info": { + "_postman_id": "da158d9e-ab95-4520-8e1f-59376d1cdf89", + "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" + }, + "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": "\"\"\"\"\"\"\"\"", + "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": "\"\"\"\"\"\"\"\"", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "\"\"\"\"\"\"\"\"", + "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": "\"\"\"\"\"\"\"\"", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "\"\"\"\"\"\"\"\"", + "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": "\"\"\"\"\"\"\"\"", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "\"\"\"\"\"\"\"\"", + "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": "\"\"\"\"\"\"\"\"", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "\"\"\"\"\"\"\"\"", + "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": "\"\"\"\"\"\"\"\"", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + }, + { + "key": "name", + "value": "\"\"\"\"\"\"\"\"" + } + ] +} \ No newline at end of file diff --git a/releases/8.40/collections/Snowflake Grant API.postman_collection.json b/releases/8.40/collections/Snowflake Grant API.postman_collection.json new file mode 100644 index 0000000..3871684 --- /dev/null +++ b/releases/8.40/collections/Snowflake Grant API.postman_collection.json @@ -0,0 +1,6064 @@ +{ + "info": { + "_postman_id": "532c3233-a65b-40e0-b5a8-f30e79949635", + "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" + }, + "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": [], + "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": "application-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": "200 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "202 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "400 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "401 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "403 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "404 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "405 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "408 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "409 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "410 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "429 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "500 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "503 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "504 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + } + ] + } + ] + }, + { + "name": "Revoke the specified privilege on the named securable from the named grantee.", + "request": { + "method": "DELETE", + "header": [], + "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": "application-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": "200 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "202 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "400 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "401 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "403 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "404 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "405 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "408 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "409 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "410 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "429 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "500 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "503 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "504 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + } + ] + } + ] + }, + { + "name": "Grant the specified privilege(s) on the named securable to the named grantee.", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "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": "application-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": "200 response", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "202 response", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "400 response", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "401 response", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "403 response", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "404 response", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "405 response", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "408 response", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "409 response", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "410 response", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "429 response", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "500 response", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "503 response", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "504 response", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "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": "text", + "header": [], + "cookie": [], + "body": "" + } + ] + } + ] + } + ] + } + ] + }, + { + "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": [], + "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": "application-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": "schema", + "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": "200 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "202 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "400 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "401 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "403 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "404 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "405 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "408 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "409 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "410 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "429 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "500 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "503 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "504 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + } + ] + } + ] + }, + { + "name": "Revoke the specified privilege on the specified all/future securable in the given scope from the named grantee.", + "request": { + "method": "DELETE", + "header": [], + "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": "application-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": "schema", + "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": "200 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "202 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "400 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "401 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "403 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "404 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "405 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "408 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "409 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "410 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "429 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "500 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "503 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "504 response", + "originalRequest": { + "method": "DELETE", + "header": [], + "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": "text", + "header": [], + "cookie": [], + "body": "" + } + ] + } + ] + }, + { + "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" + } + ], + "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": "application-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": "schema", + "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": "200 response", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "202 response", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "400 response", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "401 response", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "403 response", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "404 response", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "405 response", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "408 response", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "409 response", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "410 response", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "429 response", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "500 response", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "503 response", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "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": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "504 response", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "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": "text", + "header": [], + "cookie": [], + "body": "" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + }, + { + "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", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName" + ], + "variable": [ + { + "key": "granteeType", + "value": "application-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", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName" + ], + "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" + } + }, + { + "key": "Link", + "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": "202 response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + } + ] + } + }, + "status": "Accepted", + "code": 202, + "_postman_previewlanguage": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "400 response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "401 response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "403 response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "404 response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "405 response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "408 response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "409 response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "410 response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + } + ] + } + }, + "status": "Gone", + "code": 410, + "_postman_previewlanguage": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "429 response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "500 response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "503 response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "text", + "header": [], + "cookie": [], + "body": "" + }, + { + "name": "504 response", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "{{baseUrl}}/api/v2/grants/:granteeType/:granteeName", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "grants", + ":granteeType", + ":granteeName" + ], + "variable": [ + { + "key": "granteeType" + }, + { + "key": "granteeName" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "text", + "header": [], + "cookie": [], + "body": "" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + } + ] +} \ No newline at end of file diff --git a/releases/8.40/collections/Snowflake Image Repository API.postman_collection.json b/releases/8.40/collections/Snowflake Image Repository API.postman_collection.json new file mode 100644 index 0000000..a8a951d --- /dev/null +++ b/releases/8.40/collections/Snowflake Image Repository API.postman_collection.json @@ -0,0 +1,4465 @@ +{ + "info": { + "_postman_id": "e4e88177-615a-4f65-8555-4e225568f6f5", + "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" + }, + "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": "sI96tA$vac9", + "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": "sI96tA$vac9", + "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": "sI96tA$vac9", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"created_on\": \"\",\n \"image_name\": \"\",\n \"tags\": \"\",\n \"digest\": \"\",\n \"image_path\": \"\"\n },\n {\n \"created_on\": \"\",\n \"image_name\": \"\",\n \"tags\": \"\",\n \"digest\": \"\",\n \"image_path\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "sI96tA$vac9", + "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": "sI96tA$vac9", + "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": "sI96tA$vac9", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"p\\\"\\\"\\\"\\\"1\\\"\",\n \"database_name\": \"\\\"'\\\"\\\"^\\\"\\\"E\\\"\\\"\\\"\",\n \"schema_name\": \"\\\"\\\"\\\"\\\"\\\"7\\\"\\\")0\\\"\\\"\\\"\\\":K\\\"\\\"\\\"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "sI96tA$vac9", + "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": "sI96tA$vac9", + "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": "sI96tA$vac9", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "sI96tA$vac9", + "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": "sI96tA$vac9", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"\\\"#\\\"\",\n \"database_name\": \"\\\"\\\"\\\"4\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"s\\\"\\\"\\\"\\\"\\\"\\\",\\\"\",\n \"schema_name\": \"\\\"\\\"\\\"T\\\"\\\"F\\\"\\\"\\\"\\\"\\\"\\\"*Q\\\"\",\n \"created_on\": \"\",\n \"repository_url\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\"\n },\n {\n \"name\": \"\\\"|b\\\"\\\"\\\"\\\"\\\"\",\n \"database_name\": \"\\\"(\\\"\\\"\\\"\\\"qN\\\"\",\n \"schema_name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"\\\",\\\"\\\"*\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database_name\": \"gs_mmVTql\",\n \"schema_name\": \"\\\"\\\"\\\"\\\"\"\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": "sI96tA$vac9", + "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": "sI96tA$vac9", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\",\\\"\\\"*\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database_name\": \"gs_mmVTql\",\n \"schema_name\": \"\\\"\\\"\\\"\\\"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\",\\\"\\\"*\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database_name\": \"gs_mmVTql\",\n \"schema_name\": \"\\\"\\\"\\\"\\\"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\",\\\"\\\"*\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database_name\": \"gs_mmVTql\",\n \"schema_name\": \"\\\"\\\"\\\"\\\"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\",\\\"\\\"*\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database_name\": \"gs_mmVTql\",\n \"schema_name\": \"\\\"\\\"\\\"\\\"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\",\\\"\\\"*\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database_name\": \"gs_mmVTql\",\n \"schema_name\": \"\\\"\\\"\\\"\\\"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\",\\\"\\\"*\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database_name\": \"gs_mmVTql\",\n \"schema_name\": \"\\\"\\\"\\\"\\\"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\",\\\"\\\"*\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database_name\": \"gs_mmVTql\",\n \"schema_name\": \"\\\"\\\"\\\"\\\"\"\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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\",\\\"\\\"*\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database_name\": \"gs_mmVTql\",\n \"schema_name\": \"\\\"\\\"\\\"\\\"\"\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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\",\\\"\\\"*\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database_name\": \"gs_mmVTql\",\n \"schema_name\": \"\\\"\\\"\\\"\\\"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\",\\\"\\\"*\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database_name\": \"gs_mmVTql\",\n \"schema_name\": \"\\\"\\\"\\\"\\\"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\",\\\"\\\"*\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database_name\": \"gs_mmVTql\",\n \"schema_name\": \"\\\"\\\"\\\"\\\"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\",\\\"\\\"*\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database_name\": \"gs_mmVTql\",\n \"schema_name\": \"\\\"\\\"\\\"\\\"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\",\\\"\\\"*\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database_name\": \"gs_mmVTql\",\n \"schema_name\": \"\\\"\\\"\\\"\\\"\"\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}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + } + ] +} \ No newline at end of file diff --git a/releases/8.40/collections/Snowflake Network Policy API.postman_collection.json b/releases/8.40/collections/Snowflake Network Policy API.postman_collection.json new file mode 100644 index 0000000..d3a5e50 --- /dev/null +++ b/releases/8.40/collections/Snowflake Network Policy API.postman_collection.json @@ -0,0 +1,3129 @@ +{ + "info": { + "_postman_id": "08b572bc-930d-4957-a29b-4c1ccbdc1bc4", + "name": "Snowflake Network Policy API", + "description": "The Snowflake Network Policy API is a REST API that you can use to access, update, and perform certain actions on Network Policy 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" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "network-policies", + "item": [ + { + "name": "{name}", + "item": [ + { + "name": "Fetch a network policy", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/network-policies/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies", + ":name" + ], + "variable": [ + { + "key": "name", + "value": "\"K6\"\"T\"\"\"\"d\"\"\"", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Fetch a network policy" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/network-policies/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies", + ":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\": \"\\\"2(\\\"\",\n \"allowed_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"blocked_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"allowed_ip_list\": [\n \"\",\n \"\"\n ],\n \"blocked_ip_list\": [\n \"\",\n \"\"\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"owner\": \"\\\"\\\"\\\"\\\"\\\"wy\\\"\\\"\\\"\\\"\\\"\",\n \"owner_role_type\": \"EtX4AaU\"\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/network-policies/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies", + ":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/network-policies/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies", + ":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/network-policies/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies", + ":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/network-policies/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies", + ":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/network-policies/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies", + ":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/network-policies/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies", + ":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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/network-policies/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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/network-policies/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies", + ":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/network-policies/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies", + ":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/network-policies/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies", + ":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/network-policies/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies", + ":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/network-policies/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies", + ":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/network-policies/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies", + ":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 network policy", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/network-policies/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies", + ":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": "\"K6\"\"T\"\"\"\"d\"\"\"", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Delete a network policy" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/network-policies/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies", + ":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/network-policies/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies", + ":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/network-policies/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies", + ":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/network-policies/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies", + ":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/network-policies/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies", + ":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/network-policies/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies", + ":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/network-policies/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies", + ":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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/network-policies/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies", + ":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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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/network-policies/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies", + ":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/network-policies/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies", + ":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/network-policies/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies", + ":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/network-policies/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies", + ":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/network-policies/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies", + ":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/network-policies/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies", + ":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": "List network policies", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/network-policies", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies" + ] + }, + "description": "List network policies" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/network-policies", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies" + ] + } + }, + "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\": \"r\",\n \"allowed_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"blocked_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"allowed_ip_list\": [\n \"\",\n \"\"\n ],\n \"blocked_ip_list\": [\n \"\",\n \"\"\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"owner\": \"GG\",\n \"owner_role_type\": \"NFBs_LYuH\"\n },\n {\n \"name\": \"hRbgs\",\n \"allowed_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"blocked_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"allowed_ip_list\": [\n \"\",\n \"\"\n ],\n \"blocked_ip_list\": [\n \"\",\n \"\"\n ],\n \"comment\": \"\",\n \"created_on\": \"\",\n \"owner\": \"\\\"\\\"\\\"\\\"\\\"#r1b\\\"\\\"&+\\\"\",\n \"owner_role_type\": \"KMT4Fxe2\"\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/network-policies", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies" + ] + } + }, + "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/network-policies", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies" + ] + } + }, + "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/network-policies", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies" + ] + } + }, + "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/network-policies", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies" + ] + } + }, + "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/network-policies", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies" + ] + } + }, + "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/network-policies", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies" + ] + } + }, + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/network-policies", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies" + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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/network-policies", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies" + ] + } + }, + "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/network-policies", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies" + ] + } + }, + "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/network-policies", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies" + ] + } + }, + "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/network-policies", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies" + ] + } + }, + "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/network-policies", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies" + ] + } + }, + "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/network-policies", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies" + ] + } + }, + "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 network policy", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"QdHqO3WUy\",\n \"allowed_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"blocked_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"allowed_ip_list\": [\n \"\",\n \"\"\n ],\n \"blocked_ip_list\": [\n \"\",\n \"\"\n ],\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/network-policies?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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 network policy" + }, + "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\": \"QdHqO3WUy\",\n \"allowed_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"blocked_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"allowed_ip_list\": [\n \"\",\n \"\"\n ],\n \"blocked_ip_list\": [\n \"\",\n \"\"\n ],\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/network-policies?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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\": \"QdHqO3WUy\",\n \"allowed_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"blocked_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"allowed_ip_list\": [\n \"\",\n \"\"\n ],\n \"blocked_ip_list\": [\n \"\",\n \"\"\n ],\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/network-policies?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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\": \"QdHqO3WUy\",\n \"allowed_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"blocked_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"allowed_ip_list\": [\n \"\",\n \"\"\n ],\n \"blocked_ip_list\": [\n \"\",\n \"\"\n ],\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/network-policies?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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\": \"QdHqO3WUy\",\n \"allowed_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"blocked_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"allowed_ip_list\": [\n \"\",\n \"\"\n ],\n \"blocked_ip_list\": [\n \"\",\n \"\"\n ],\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/network-policies?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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\": \"QdHqO3WUy\",\n \"allowed_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"blocked_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"allowed_ip_list\": [\n \"\",\n \"\"\n ],\n \"blocked_ip_list\": [\n \"\",\n \"\"\n ],\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/network-policies?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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\": \"QdHqO3WUy\",\n \"allowed_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"blocked_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"allowed_ip_list\": [\n \"\",\n \"\"\n ],\n \"blocked_ip_list\": [\n \"\",\n \"\"\n ],\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/network-policies?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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\": \"QdHqO3WUy\",\n \"allowed_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"blocked_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"allowed_ip_list\": [\n \"\",\n \"\"\n ],\n \"blocked_ip_list\": [\n \"\",\n \"\"\n ],\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/network-policies?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"QdHqO3WUy\",\n \"allowed_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"blocked_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"allowed_ip_list\": [\n \"\",\n \"\"\n ],\n \"blocked_ip_list\": [\n \"\",\n \"\"\n ],\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/network-policies?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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\": \"QdHqO3WUy\",\n \"allowed_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"blocked_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"allowed_ip_list\": [\n \"\",\n \"\"\n ],\n \"blocked_ip_list\": [\n \"\",\n \"\"\n ],\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/network-policies?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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\": \"QdHqO3WUy\",\n \"allowed_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"blocked_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"allowed_ip_list\": [\n \"\",\n \"\"\n ],\n \"blocked_ip_list\": [\n \"\",\n \"\"\n ],\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/network-policies?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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\": \"QdHqO3WUy\",\n \"allowed_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"blocked_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"allowed_ip_list\": [\n \"\",\n \"\"\n ],\n \"blocked_ip_list\": [\n \"\",\n \"\"\n ],\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/network-policies?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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\": \"QdHqO3WUy\",\n \"allowed_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"blocked_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"allowed_ip_list\": [\n \"\",\n \"\"\n ],\n \"blocked_ip_list\": [\n \"\",\n \"\"\n ],\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/network-policies?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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\": \"QdHqO3WUy\",\n \"allowed_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"blocked_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"allowed_ip_list\": [\n \"\",\n \"\"\n ],\n \"blocked_ip_list\": [\n \"\",\n \"\"\n ],\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/network-policies?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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\": \"QdHqO3WUy\",\n \"allowed_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"blocked_network_rule_list\": [\n \"\",\n \"\"\n ],\n \"allowed_ip_list\": [\n \"\",\n \"\"\n ],\n \"blocked_ip_list\": [\n \"\",\n \"\"\n ],\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/network-policies?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "network-policies" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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}" + } + ] + } + ] + } + ] + } + ] + } + ], + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + } + ] +} \ No newline at end of file diff --git a/releases/8.40/collections/Snowflake Notebook API.postman_collection.json b/releases/8.40/collections/Snowflake Notebook API.postman_collection.json new file mode 100644 index 0000000..ca07483 --- /dev/null +++ b/releases/8.40/collections/Snowflake Notebook API.postman_collection.json @@ -0,0 +1,8844 @@ +{ + "info": { + "_postman_id": "94a9bd3a-e0c1-4a08-9e35-134dd8ad96af", + "name": "Snowflake Notebook API", + "description": "The Snowflake Notebook API is a REST API that you can use to access, update, and perform certain actions on Notebook 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" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "databases", + "item": [ + { + "name": "{database}", + "item": [ + { + "name": "schemas", + "item": [ + { + "name": "{schema}", + "item": [ + { + "name": "notebooks", + "item": [ + { + "name": "{name}", + "item": [ + { + "name": "Fetch a notebook", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + ":name" + ], + "variable": [ + { + "key": "database", + "value": "kZdyHa", + "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": "kZdyHa", + "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": "kZdyHa", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Fetch a notebook" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + ":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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\".i\\\"\\\"\\\"\\\" \\\"\\\"\\\"\",\n \"version\": \"\",\n \"fromLocation\": \"\",\n \"main_file\": \"\",\n \"comment\": \"\",\n \"default_version\": \"\",\n \"query_warehouse\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\\\"Y\\\"\\\"\\\"\\\"\\\"\",\n \"schema_name\": \"\\\"M\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"k\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"owner\": \"\\\"\\\"\\\"G\\\"\\\"\\\"\\\"\\\"\\\"q\\\"\\\"j\\\"\\\"\\\"\\\"\\\"\",\n \"owner_role_type\": \"\\\"\\\"\\\"NE\\\"\",\n \"url_id\": \"\",\n \"title\": \"\",\n \"default_packages\": \"\",\n \"user_packages\": \"\",\n \"runtime_name\": \"\",\n \"compute_pool\": \"\",\n \"import_urls\": [\n \"\",\n \"\"\n ],\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"external_access_secrets\": \"\",\n \"idle_auto_shutdown_time_seconds\": \"\",\n \"default_version_details\": {\n \"name\": \"\",\n \"alias\": \"\",\n \"location_url\": \"\",\n \"source_location_uri\": \"\",\n \"git_commit_hash\": \"\"\n },\n \"last_version_details\": {\n \"name\": \"\",\n \"alias\": \"\",\n \"location_url\": \"\",\n \"source_location_uri\": \"\",\n \"git_commit_hash\": \"\"\n },\n \"live_version_location_uri\": \"\",\n \"budget\": \"BJwHc\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + ":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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + ":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 notebook", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + ":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": "kZdyHa", + "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": "kZdyHa", + "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": "kZdyHa", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Delete a notebook" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + ":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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + ":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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + ":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 Notebook", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:execute?asyncExec=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:execute" + ], + "query": [ + { + "key": "asyncExec", + "value": "false", + "description": "Asynchronous execution enable/disable. Default is disable." + } + ], + "variable": [ + { + "key": "database", + "value": "kZdyHa", + "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": "kZdyHa", + "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 Notebook" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:execute?asyncExec=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:execute" + ], + "query": [ + { + "key": "asyncExec", + "value": "false", + "description": "Asynchronous execution enable/disable. Default is disable." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:execute?asyncExec=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:execute" + ], + "query": [ + { + "key": "asyncExec", + "value": "false", + "description": "Asynchronous execution enable/disable. Default is disable." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:execute?asyncExec=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:execute" + ], + "query": [ + { + "key": "asyncExec", + "value": "false", + "description": "Asynchronous execution enable/disable. Default is disable." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:execute?asyncExec=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:execute" + ], + "query": [ + { + "key": "asyncExec", + "value": "false", + "description": "Asynchronous execution enable/disable. Default is disable." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:execute?asyncExec=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:execute" + ], + "query": [ + { + "key": "asyncExec", + "value": "false", + "description": "Asynchronous execution enable/disable. Default is disable." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:execute?asyncExec=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:execute" + ], + "query": [ + { + "key": "asyncExec", + "value": "false", + "description": "Asynchronous execution enable/disable. Default is disable." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:execute?asyncExec=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:execute" + ], + "query": [ + { + "key": "asyncExec", + "value": "false", + "description": "Asynchronous execution enable/disable. Default is disable." + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:execute?asyncExec=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:execute" + ], + "query": [ + { + "key": "asyncExec", + "value": "false", + "description": "Asynchronous execution enable/disable. Default is disable." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:execute?asyncExec=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:execute" + ], + "query": [ + { + "key": "asyncExec", + "value": "false", + "description": "Asynchronous execution enable/disable. Default is disable." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:execute?asyncExec=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:execute" + ], + "query": [ + { + "key": "asyncExec", + "value": "false", + "description": "Asynchronous execution enable/disable. Default is disable." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:execute?asyncExec=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:execute" + ], + "query": [ + { + "key": "asyncExec", + "value": "false", + "description": "Asynchronous execution enable/disable. Default is disable." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:execute?asyncExec=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:execute" + ], + "query": [ + { + "key": "asyncExec", + "value": "false", + "description": "Asynchronous execution enable/disable. Default is disable." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:execute?asyncExec=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:execute" + ], + "query": [ + { + "key": "asyncExec", + "value": "false", + "description": "Asynchronous execution enable/disable. Default is disable." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:execute?asyncExec=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:execute" + ], + "query": [ + { + "key": "asyncExec", + "value": "false", + "description": "Asynchronous execution enable/disable. Default is disable." + } + ], + "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}:rename", + "item": [ + { + "name": "Changes the name of the notebook to new name. The new identifier must be unique for the schema.", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:rename?ifExists=false&targetDatabase=\"\"\"\"\"\"&targetSchema=\"\"\"\"\"\"&targetName=\"\"\"\"\"\"", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{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." + }, + { + "key": "targetDatabase", + "value": "\"\"\"\"\"\"", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "\"\"\"\"\"\"", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "key": "targetName", + "value": "\"\"\"\"\"\"", + "description": "(Required) Name of the target resource." + } + ], + "variable": [ + { + "key": "database", + "value": "kZdyHa", + "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": "kZdyHa", + "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": "Changes the name of the notebook to new name. The new identifier must be unique for the schema." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:rename?ifExists=false&targetDatabase=\"\"\"\"\"\"&targetSchema=\"\"\"\"\"\"&targetName=\"\"\"\"\"\"", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{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." + }, + { + "key": "targetDatabase", + "value": "\"\"\"\"\"\"", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "\"\"\"\"\"\"", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "key": "targetName", + "value": "\"\"\"\"\"\"", + "description": "(Required) Name of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:rename?ifExists=false&targetDatabase=\"\"\"\"\"\"&targetSchema=\"\"\"\"\"\"&targetName=\"\"\"\"\"\"", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{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." + }, + { + "key": "targetDatabase", + "value": "\"\"\"\"\"\"", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "\"\"\"\"\"\"", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "key": "targetName", + "value": "\"\"\"\"\"\"", + "description": "(Required) Name of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:rename?ifExists=false&targetDatabase=\"\"\"\"\"\"&targetSchema=\"\"\"\"\"\"&targetName=\"\"\"\"\"\"", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{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." + }, + { + "key": "targetDatabase", + "value": "\"\"\"\"\"\"", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "\"\"\"\"\"\"", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "key": "targetName", + "value": "\"\"\"\"\"\"", + "description": "(Required) Name of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:rename?ifExists=false&targetDatabase=\"\"\"\"\"\"&targetSchema=\"\"\"\"\"\"&targetName=\"\"\"\"\"\"", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{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." + }, + { + "key": "targetDatabase", + "value": "\"\"\"\"\"\"", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "\"\"\"\"\"\"", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "key": "targetName", + "value": "\"\"\"\"\"\"", + "description": "(Required) Name of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:rename?ifExists=false&targetDatabase=\"\"\"\"\"\"&targetSchema=\"\"\"\"\"\"&targetName=\"\"\"\"\"\"", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{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." + }, + { + "key": "targetDatabase", + "value": "\"\"\"\"\"\"", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "\"\"\"\"\"\"", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "key": "targetName", + "value": "\"\"\"\"\"\"", + "description": "(Required) Name of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:rename?ifExists=false&targetDatabase=\"\"\"\"\"\"&targetSchema=\"\"\"\"\"\"&targetName=\"\"\"\"\"\"", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{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." + }, + { + "key": "targetDatabase", + "value": "\"\"\"\"\"\"", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "\"\"\"\"\"\"", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "key": "targetName", + "value": "\"\"\"\"\"\"", + "description": "(Required) Name of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:rename?ifExists=false&targetDatabase=\"\"\"\"\"\"&targetSchema=\"\"\"\"\"\"&targetName=\"\"\"\"\"\"", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{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." + }, + { + "key": "targetDatabase", + "value": "\"\"\"\"\"\"", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "\"\"\"\"\"\"", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "key": "targetName", + "value": "\"\"\"\"\"\"", + "description": "(Required) Name of the target 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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:rename?ifExists=false&targetDatabase=\"\"\"\"\"\"&targetSchema=\"\"\"\"\"\"&targetName=\"\"\"\"\"\"", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{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." + }, + { + "key": "targetDatabase", + "value": "\"\"\"\"\"\"", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "\"\"\"\"\"\"", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "key": "targetName", + "value": "\"\"\"\"\"\"", + "description": "(Required) Name of the target resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:rename?ifExists=false&targetDatabase=\"\"\"\"\"\"&targetSchema=\"\"\"\"\"\"&targetName=\"\"\"\"\"\"", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{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." + }, + { + "key": "targetDatabase", + "value": "\"\"\"\"\"\"", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "\"\"\"\"\"\"", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "key": "targetName", + "value": "\"\"\"\"\"\"", + "description": "(Required) Name of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:rename?ifExists=false&targetDatabase=\"\"\"\"\"\"&targetSchema=\"\"\"\"\"\"&targetName=\"\"\"\"\"\"", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{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." + }, + { + "key": "targetDatabase", + "value": "\"\"\"\"\"\"", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "\"\"\"\"\"\"", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "key": "targetName", + "value": "\"\"\"\"\"\"", + "description": "(Required) Name of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:rename?ifExists=false&targetDatabase=\"\"\"\"\"\"&targetSchema=\"\"\"\"\"\"&targetName=\"\"\"\"\"\"", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{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." + }, + { + "key": "targetDatabase", + "value": "\"\"\"\"\"\"", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "\"\"\"\"\"\"", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "key": "targetName", + "value": "\"\"\"\"\"\"", + "description": "(Required) Name of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:rename?ifExists=false&targetDatabase=\"\"\"\"\"\"&targetSchema=\"\"\"\"\"\"&targetName=\"\"\"\"\"\"", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{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." + }, + { + "key": "targetDatabase", + "value": "\"\"\"\"\"\"", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "\"\"\"\"\"\"", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "key": "targetName", + "value": "\"\"\"\"\"\"", + "description": "(Required) Name of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:rename?ifExists=false&targetDatabase=\"\"\"\"\"\"&targetSchema=\"\"\"\"\"\"&targetName=\"\"\"\"\"\"", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{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." + }, + { + "key": "targetDatabase", + "value": "\"\"\"\"\"\"", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "\"\"\"\"\"\"", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "key": "targetName", + "value": "\"\"\"\"\"\"", + "description": "(Required) Name of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:rename?ifExists=false&targetDatabase=\"\"\"\"\"\"&targetSchema=\"\"\"\"\"\"&targetName=\"\"\"\"\"\"", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{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." + }, + { + "key": "targetDatabase", + "value": "\"\"\"\"\"\"", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "\"\"\"\"\"\"", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "key": "targetName", + "value": "\"\"\"\"\"\"", + "description": "(Required) Name of the target 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}" + } + ] + } + ] + }, + { + "name": "{name}:add-live-version", + "item": [ + { + "name": "Adds a LIVE version to the notebook", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:add-live-version?fromLast=&comment=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:add-live-version" + ], + "query": [ + { + "key": "fromLast", + "value": "", + "description": "Sets the LIVE version to the LAST version of the notebook" + }, + { + "key": "comment", + "value": "", + "description": "Sets a comment for the notebook or version of the notebook" + } + ], + "variable": [ + { + "key": "database", + "value": "kZdyHa", + "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": "kZdyHa", + "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": "Adds a LIVE version to the notebook" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:add-live-version?fromLast=&comment=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:add-live-version" + ], + "query": [ + { + "key": "fromLast", + "value": "", + "description": "Sets the LIVE version to the LAST version of the notebook" + }, + { + "key": "comment", + "value": "", + "description": "Sets a comment for the notebook or version of the notebook" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:add-live-version?fromLast=&comment=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:add-live-version" + ], + "query": [ + { + "key": "fromLast", + "value": "", + "description": "Sets the LIVE version to the LAST version of the notebook" + }, + { + "key": "comment", + "value": "", + "description": "Sets a comment for the notebook or version of the notebook" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:add-live-version?fromLast=&comment=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:add-live-version" + ], + "query": [ + { + "key": "fromLast", + "value": "", + "description": "Sets the LIVE version to the LAST version of the notebook" + }, + { + "key": "comment", + "value": "", + "description": "Sets a comment for the notebook or version of the notebook" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:add-live-version?fromLast=&comment=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:add-live-version" + ], + "query": [ + { + "key": "fromLast", + "value": "", + "description": "Sets the LIVE version to the LAST version of the notebook" + }, + { + "key": "comment", + "value": "", + "description": "Sets a comment for the notebook or version of the notebook" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:add-live-version?fromLast=&comment=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:add-live-version" + ], + "query": [ + { + "key": "fromLast", + "value": "", + "description": "Sets the LIVE version to the LAST version of the notebook" + }, + { + "key": "comment", + "value": "", + "description": "Sets a comment for the notebook or version of the notebook" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:add-live-version?fromLast=&comment=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:add-live-version" + ], + "query": [ + { + "key": "fromLast", + "value": "", + "description": "Sets the LIVE version to the LAST version of the notebook" + }, + { + "key": "comment", + "value": "", + "description": "Sets a comment for the notebook or version of the notebook" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:add-live-version?fromLast=&comment=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:add-live-version" + ], + "query": [ + { + "key": "fromLast", + "value": "", + "description": "Sets the LIVE version to the LAST version of the notebook" + }, + { + "key": "comment", + "value": "", + "description": "Sets a comment for the notebook or version of the notebook" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:add-live-version?fromLast=&comment=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:add-live-version" + ], + "query": [ + { + "key": "fromLast", + "value": "", + "description": "Sets the LIVE version to the LAST version of the notebook" + }, + { + "key": "comment", + "value": "", + "description": "Sets a comment for the notebook or version of the notebook" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:add-live-version?fromLast=&comment=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:add-live-version" + ], + "query": [ + { + "key": "fromLast", + "value": "", + "description": "Sets the LIVE version to the LAST version of the notebook" + }, + { + "key": "comment", + "value": "", + "description": "Sets a comment for the notebook or version of the notebook" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:add-live-version?fromLast=&comment=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:add-live-version" + ], + "query": [ + { + "key": "fromLast", + "value": "", + "description": "Sets the LIVE version to the LAST version of the notebook" + }, + { + "key": "comment", + "value": "", + "description": "Sets a comment for the notebook or version of the notebook" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:add-live-version?fromLast=&comment=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:add-live-version" + ], + "query": [ + { + "key": "fromLast", + "value": "", + "description": "Sets the LIVE version to the LAST version of the notebook" + }, + { + "key": "comment", + "value": "", + "description": "Sets a comment for the notebook or version of the notebook" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:add-live-version?fromLast=&comment=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:add-live-version" + ], + "query": [ + { + "key": "fromLast", + "value": "", + "description": "Sets the LIVE version to the LAST version of the notebook" + }, + { + "key": "comment", + "value": "", + "description": "Sets a comment for the notebook or version of the notebook" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:add-live-version?fromLast=&comment=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:add-live-version" + ], + "query": [ + { + "key": "fromLast", + "value": "", + "description": "Sets the LIVE version to the LAST version of the notebook" + }, + { + "key": "comment", + "value": "", + "description": "Sets a comment for the notebook or version of the notebook" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:add-live-version?fromLast=&comment=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:add-live-version" + ], + "query": [ + { + "key": "fromLast", + "value": "", + "description": "Sets the LIVE version to the LAST version of the notebook" + }, + { + "key": "comment", + "value": "", + "description": "Sets a comment for the notebook or version of the notebook" + } + ], + "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}:commit", + "item": [ + { + "name": "If a Git connection is set up for the notebook, commits the LIVE version of the notebook to the Git repository", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:commit?version=&comment=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:commit" + ], + "query": [ + { + "key": "version", + "value": "", + "description": "live version of the alias" + }, + { + "key": "comment", + "value": "", + "description": "Sets a comment for the notebook or version of the notebook" + } + ], + "variable": [ + { + "key": "database", + "value": "kZdyHa", + "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": "kZdyHa", + "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": "If a Git connection is set up for the notebook, commits the LIVE version of the notebook to the Git repository" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:commit?version=&comment=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:commit" + ], + "query": [ + { + "key": "version", + "value": "", + "description": "live version of the alias" + }, + { + "key": "comment", + "value": "", + "description": "Sets a comment for the notebook or version of the notebook" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:commit?version=&comment=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:commit" + ], + "query": [ + { + "key": "version", + "value": "", + "description": "live version of the alias" + }, + { + "key": "comment", + "value": "", + "description": "Sets a comment for the notebook or version of the notebook" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:commit?version=&comment=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:commit" + ], + "query": [ + { + "key": "version", + "value": "", + "description": "live version of the alias" + }, + { + "key": "comment", + "value": "", + "description": "Sets a comment for the notebook or version of the notebook" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:commit?version=&comment=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:commit" + ], + "query": [ + { + "key": "version", + "value": "", + "description": "live version of the alias" + }, + { + "key": "comment", + "value": "", + "description": "Sets a comment for the notebook or version of the notebook" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:commit?version=&comment=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:commit" + ], + "query": [ + { + "key": "version", + "value": "", + "description": "live version of the alias" + }, + { + "key": "comment", + "value": "", + "description": "Sets a comment for the notebook or version of the notebook" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:commit?version=&comment=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:commit" + ], + "query": [ + { + "key": "version", + "value": "", + "description": "live version of the alias" + }, + { + "key": "comment", + "value": "", + "description": "Sets a comment for the notebook or version of the notebook" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:commit?version=&comment=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:commit" + ], + "query": [ + { + "key": "version", + "value": "", + "description": "live version of the alias" + }, + { + "key": "comment", + "value": "", + "description": "Sets a comment for the notebook or version of the notebook" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:commit?version=&comment=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:commit" + ], + "query": [ + { + "key": "version", + "value": "", + "description": "live version of the alias" + }, + { + "key": "comment", + "value": "", + "description": "Sets a comment for the notebook or version of the notebook" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:commit?version=&comment=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:commit" + ], + "query": [ + { + "key": "version", + "value": "", + "description": "live version of the alias" + }, + { + "key": "comment", + "value": "", + "description": "Sets a comment for the notebook or version of the notebook" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:commit?version=&comment=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:commit" + ], + "query": [ + { + "key": "version", + "value": "", + "description": "live version of the alias" + }, + { + "key": "comment", + "value": "", + "description": "Sets a comment for the notebook or version of the notebook" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:commit?version=&comment=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:commit" + ], + "query": [ + { + "key": "version", + "value": "", + "description": "live version of the alias" + }, + { + "key": "comment", + "value": "", + "description": "Sets a comment for the notebook or version of the notebook" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:commit?version=&comment=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:commit" + ], + "query": [ + { + "key": "version", + "value": "", + "description": "live version of the alias" + }, + { + "key": "comment", + "value": "", + "description": "Sets a comment for the notebook or version of the notebook" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:commit?version=&comment=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:commit" + ], + "query": [ + { + "key": "version", + "value": "", + "description": "live version of the alias" + }, + { + "key": "comment", + "value": "", + "description": "Sets a comment for the notebook or version of the notebook" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks/{{name}}:commit?version=&comment=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks", + "{{name}}:commit" + ], + "query": [ + { + "key": "version", + "value": "", + "description": "live version of the alias" + }, + { + "key": "comment", + "value": "", + "description": "Sets a comment for the notebook or version of the notebook" + } + ], + "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 notebooks", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks" + ], + "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": "kZdyHa", + "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": "kZdyHa", + "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": "List notebooks" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks" + ], + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"JezBrm$\",\n \"version\": \"\",\n \"fromLocation\": \"\",\n \"main_file\": \"\",\n \"comment\": \"\",\n \"default_version\": \"\",\n \"query_warehouse\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\\\"+\\\"\\\"\\\"\\\"\\\"\",\n \"schema_name\": \"\\\"U\\\"\\\")\\\"\\\"0\\\"\\\"\\\"\",\n \"owner\": \"\\\"(?\\\"\",\n \"owner_role_type\": \"D_VN0LiZaf\",\n \"url_id\": \"\",\n \"title\": \"\",\n \"default_packages\": \"\",\n \"user_packages\": \"\",\n \"runtime_name\": \"\",\n \"compute_pool\": \"\",\n \"import_urls\": [\n \"\",\n \"\"\n ],\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"external_access_secrets\": \"\",\n \"idle_auto_shutdown_time_seconds\": \"\",\n \"default_version_details\": {\n \"name\": \"\",\n \"alias\": \"\",\n \"location_url\": \"\",\n \"source_location_uri\": \"\",\n \"git_commit_hash\": \"\"\n },\n \"last_version_details\": {\n \"name\": \"\",\n \"alias\": \"\",\n \"location_url\": \"\",\n \"source_location_uri\": \"\",\n \"git_commit_hash\": \"\"\n },\n \"live_version_location_uri\": \"\",\n \"budget\": \"\\\"0\\\"\\\"y\\\"\\\"Lk\\\"\"\n },\n {\n \"name\": \"\\\"A^e\\\"\\\"\\\"\\\"Y\\\"\",\n \"version\": \"\",\n \"fromLocation\": \"\",\n \"main_file\": \"\",\n \"comment\": \"\",\n \"default_version\": \"\",\n \"query_warehouse\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\\\"\\\"\\\"\\\"\\\"cDx_\\\"\\\"\\\"\",\n \"schema_name\": \"ulDbr\",\n \"owner\": \"\\\"lS\\\"\\\"3\\\"\\\"m\\\"\\\"_1\\\"\",\n \"owner_role_type\": \"s\",\n \"url_id\": \"\",\n \"title\": \"\",\n \"default_packages\": \"\",\n \"user_packages\": \"\",\n \"runtime_name\": \"\",\n \"compute_pool\": \"\",\n \"import_urls\": [\n \"\",\n \"\"\n ],\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"external_access_secrets\": \"\",\n \"idle_auto_shutdown_time_seconds\": \"\",\n \"default_version_details\": {\n \"name\": \"\",\n \"alias\": \"\",\n \"location_url\": \"\",\n \"source_location_uri\": \"\",\n \"git_commit_hash\": \"\"\n },\n \"last_version_details\": {\n \"name\": \"\",\n \"alias\": \"\",\n \"location_url\": \"\",\n \"source_location_uri\": \"\",\n \"git_commit_hash\": \"\"\n },\n \"live_version_location_uri\": \"\",\n \"budget\": \"_\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks" + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks" + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks" + ], + "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": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks" + ], + "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": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks" + ], + "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 notebook", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"sU\",\n \"version\": \"\",\n \"fromLocation\": \"\",\n \"main_file\": \"\",\n \"comment\": \"\",\n \"default_version\": \"\",\n \"query_warehouse\": \"\",\n \"default_version_details\": {},\n \"last_version_details\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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": "kZdyHa", + "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": "kZdyHa", + "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 notebook" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"sU\",\n \"version\": \"\",\n \"fromLocation\": \"\",\n \"main_file\": \"\",\n \"comment\": \"\",\n \"default_version\": \"\",\n \"query_warehouse\": \"\",\n \"default_version_details\": {},\n \"last_version_details\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"sU\",\n \"version\": \"\",\n \"fromLocation\": \"\",\n \"main_file\": \"\",\n \"comment\": \"\",\n \"default_version\": \"\",\n \"query_warehouse\": \"\",\n \"default_version_details\": {},\n \"last_version_details\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"sU\",\n \"version\": \"\",\n \"fromLocation\": \"\",\n \"main_file\": \"\",\n \"comment\": \"\",\n \"default_version\": \"\",\n \"query_warehouse\": \"\",\n \"default_version_details\": {},\n \"last_version_details\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"sU\",\n \"version\": \"\",\n \"fromLocation\": \"\",\n \"main_file\": \"\",\n \"comment\": \"\",\n \"default_version\": \"\",\n \"query_warehouse\": \"\",\n \"default_version_details\": {},\n \"last_version_details\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"sU\",\n \"version\": \"\",\n \"fromLocation\": \"\",\n \"main_file\": \"\",\n \"comment\": \"\",\n \"default_version\": \"\",\n \"query_warehouse\": \"\",\n \"default_version_details\": {},\n \"last_version_details\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"sU\",\n \"version\": \"\",\n \"fromLocation\": \"\",\n \"main_file\": \"\",\n \"comment\": \"\",\n \"default_version\": \"\",\n \"query_warehouse\": \"\",\n \"default_version_details\": {},\n \"last_version_details\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"sU\",\n \"version\": \"\",\n \"fromLocation\": \"\",\n \"main_file\": \"\",\n \"comment\": \"\",\n \"default_version\": \"\",\n \"query_warehouse\": \"\",\n \"default_version_details\": {},\n \"last_version_details\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"sU\",\n \"version\": \"\",\n \"fromLocation\": \"\",\n \"main_file\": \"\",\n \"comment\": \"\",\n \"default_version\": \"\",\n \"query_warehouse\": \"\",\n \"default_version_details\": {},\n \"last_version_details\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"sU\",\n \"version\": \"\",\n \"fromLocation\": \"\",\n \"main_file\": \"\",\n \"comment\": \"\",\n \"default_version\": \"\",\n \"query_warehouse\": \"\",\n \"default_version_details\": {},\n \"last_version_details\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"sU\",\n \"version\": \"\",\n \"fromLocation\": \"\",\n \"main_file\": \"\",\n \"comment\": \"\",\n \"default_version\": \"\",\n \"query_warehouse\": \"\",\n \"default_version_details\": {},\n \"last_version_details\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"sU\",\n \"version\": \"\",\n \"fromLocation\": \"\",\n \"main_file\": \"\",\n \"comment\": \"\",\n \"default_version\": \"\",\n \"query_warehouse\": \"\",\n \"default_version_details\": {},\n \"last_version_details\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"sU\",\n \"version\": \"\",\n \"fromLocation\": \"\",\n \"main_file\": \"\",\n \"comment\": \"\",\n \"default_version\": \"\",\n \"query_warehouse\": \"\",\n \"default_version_details\": {},\n \"last_version_details\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"sU\",\n \"version\": \"\",\n \"fromLocation\": \"\",\n \"main_file\": \"\",\n \"comment\": \"\",\n \"default_version\": \"\",\n \"query_warehouse\": \"\",\n \"default_version_details\": {},\n \"last_version_details\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"sU\",\n \"version\": \"\",\n \"fromLocation\": \"\",\n \"main_file\": \"\",\n \"comment\": \"\",\n \"default_version\": \"\",\n \"query_warehouse\": \"\",\n \"default_version_details\": {},\n \"last_version_details\": {}\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/notebooks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "notebooks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + }, + { + "key": "name", + "value": "kZdyHa" + } + ] +} \ No newline at end of file diff --git a/releases/8.40/collections/Snowflake Notification Integration API.postman_collection.json b/releases/8.40/collections/Snowflake Notification Integration API.postman_collection.json new file mode 100644 index 0000000..f514d81 --- /dev/null +++ b/releases/8.40/collections/Snowflake Notification Integration API.postman_collection.json @@ -0,0 +1,3540 @@ +{ + "info": { + "_postman_id": "8e4b68f7-161a-412f-9634-9796b3667f34", + "name": "Snowflake Notification Integration API", + "description": "The Snowflake Notification Integration API is a REST API that you can use to access, update, and perform certain actions on Notification Integration 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" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "notification-integrations", + "item": [ + { + "name": "{name}", + "item": [ + { + "name": "Fetch a notification integration", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations", + ":name" + ], + "variable": [ + { + "key": "name", + "value": "\";\"\"U\"\"\"\"#\"\"\"\"\"", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Fetch a notification integration" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations", + ":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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"name\": \"vOW3H8tiv\",\n \"notification_hook\": {\n \"type\": \"WEBHOOK\"\n },\n \"enabled\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations", + ":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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations", + ":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 notification integration", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations", + ":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": "\";\"\"U\"\"\"\"#\"\"\"\"\"", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Delete a notification integration" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations", + ":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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations", + ":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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations", + ":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": "List notification integrations", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations" + ], + "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": "List notification integrations" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations" + ], + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"\\\"\\\"\\\"\\\"\",\n \"notification_hook\": {\n \"type\": \"QUEUE_GCP_PUBSUB_OUTBOUND\"\n },\n \"enabled\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\"\n },\n {\n \"name\": \"Ifi\",\n \"notification_hook\": {\n \"type\": \"QUEUE_AWS_SNS_OUTBOUND\"\n },\n \"enabled\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations" + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations" + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations" + ], + "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}" + } + ] + }, + { + "name": "Create a notification integration", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"N\\\"\\\"\\\"\\\"\\\"\\\"Jv\\\"\\\"\\\"\",\n \"notification_hook\": {\n \"type\": \"EMAIL\"\n },\n \"enabled\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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 notification integration" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"N\\\"\\\"\\\"\\\"\\\"\\\"Jv\\\"\\\"\\\"\",\n \"notification_hook\": {\n \"type\": \"EMAIL\"\n },\n \"enabled\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"N\\\"\\\"\\\"\\\"\\\"\\\"Jv\\\"\\\"\\\"\",\n \"notification_hook\": {\n \"type\": \"EMAIL\"\n },\n \"enabled\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"N\\\"\\\"\\\"\\\"\\\"\\\"Jv\\\"\\\"\\\"\",\n \"notification_hook\": {\n \"type\": \"EMAIL\"\n },\n \"enabled\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"N\\\"\\\"\\\"\\\"\\\"\\\"Jv\\\"\\\"\\\"\",\n \"notification_hook\": {\n \"type\": \"EMAIL\"\n },\n \"enabled\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"N\\\"\\\"\\\"\\\"\\\"\\\"Jv\\\"\\\"\\\"\",\n \"notification_hook\": {\n \"type\": \"EMAIL\"\n },\n \"enabled\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"N\\\"\\\"\\\"\\\"\\\"\\\"Jv\\\"\\\"\\\"\",\n \"notification_hook\": {\n \"type\": \"EMAIL\"\n },\n \"enabled\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"N\\\"\\\"\\\"\\\"\\\"\\\"Jv\\\"\\\"\\\"\",\n \"notification_hook\": {\n \"type\": \"EMAIL\"\n },\n \"enabled\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"N\\\"\\\"\\\"\\\"\\\"\\\"Jv\\\"\\\"\\\"\",\n \"notification_hook\": {\n \"type\": \"EMAIL\"\n },\n \"enabled\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"N\\\"\\\"\\\"\\\"\\\"\\\"Jv\\\"\\\"\\\"\",\n \"notification_hook\": {\n \"type\": \"EMAIL\"\n },\n \"enabled\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"N\\\"\\\"\\\"\\\"\\\"\\\"Jv\\\"\\\"\\\"\",\n \"notification_hook\": {\n \"type\": \"EMAIL\"\n },\n \"enabled\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"N\\\"\\\"\\\"\\\"\\\"\\\"Jv\\\"\\\"\\\"\",\n \"notification_hook\": {\n \"type\": \"EMAIL\"\n },\n \"enabled\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"N\\\"\\\"\\\"\\\"\\\"\\\"Jv\\\"\\\"\\\"\",\n \"notification_hook\": {\n \"type\": \"EMAIL\"\n },\n \"enabled\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"N\\\"\\\"\\\"\\\"\\\"\\\"Jv\\\"\\\"\\\"\",\n \"notification_hook\": {\n \"type\": \"EMAIL\"\n },\n \"enabled\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"N\\\"\\\"\\\"\\\"\\\"\\\"Jv\\\"\\\"\\\"\",\n \"notification_hook\": {\n \"type\": \"EMAIL\"\n },\n \"enabled\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/notification-integrations?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "notification-integrations" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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}" + } + ] + } + ] + } + ] + } + ] + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + } + ] +} \ No newline at end of file diff --git a/releases/8.40/collections/Snowflake Pipe API.postman_collection.json b/releases/8.40/collections/Snowflake Pipe API.postman_collection.json new file mode 100644 index 0000000..763b272 --- /dev/null +++ b/releases/8.40/collections/Snowflake Pipe API.postman_collection.json @@ -0,0 +1,5375 @@ +{ + "info": { + "_postman_id": "4f1b9042-8f1e-4bb6-8540-ae82ad5325ed", + "name": "Snowflake Pipe API", + "description": "The Snowflake Pipe API is a REST API that you can use to access, update, and perform certain actions on Pipe 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" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "databases", + "item": [ + { + "name": "{database}", + "item": [ + { + "name": "schemas", + "item": [ + { + "name": "{schema}", + "item": [ + { + "name": "pipes", + "item": [ + { + "name": "{name}", + "item": [ + { + "name": "Fetch a pipe", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + ":name" + ], + "variable": [ + { + "key": "database", + "value": "\"\"\"\"\"\"\"@hF\"", + "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": "\"\"\"\"\"\"\"@hF\"", + "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": "\"\"\"\"\"\"\"@hF\"", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Fetch a pipe" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + ":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": "null" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + ":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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + ":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 pipe", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + ":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": "\"\"\"\"\"\"\"@hF\"", + "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": "\"\"\"\"\"\"\"@hF\"", + "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": "\"\"\"\"\"\"\"@hF\"", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Delete a pipe" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + ":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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + ":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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + ":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}:refresh", + "item": [ + { + "name": "Refresh the pipe", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/{{name}}:refresh?ifExists=false&prefix=&modified_after=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + "{{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." + }, + { + "key": "prefix", + "value": "", + "description": "Path (or prefix) appended to the stage reference in the pipe definition. The path limits the set of files to load." + }, + { + "key": "modified_after", + "value": "", + "description": "Timestamp (in ISO-8601 format) of the oldest data files to copy into the Snowpipe ingest queue based on the LAST_MODIFIED date (i.e. date when a file was staged)" + } + ], + "variable": [ + { + "key": "database", + "value": "\"\"\"\"\"\"\"@hF\"", + "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": "\"\"\"\"\"\"\"@hF\"", + "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": "Refresh the pipe" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/{{name}}:refresh?ifExists=false&prefix=&modified_after=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + "{{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." + }, + { + "key": "prefix", + "value": "", + "description": "Path (or prefix) appended to the stage reference in the pipe definition. The path limits the set of files to load." + }, + { + "key": "modified_after", + "value": "", + "description": "Timestamp (in ISO-8601 format) of the oldest data files to copy into the Snowpipe ingest queue based on the LAST_MODIFIED date (i.e. date when a file was staged)" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/{{name}}:refresh?ifExists=false&prefix=&modified_after=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + "{{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." + }, + { + "key": "prefix", + "value": "", + "description": "Path (or prefix) appended to the stage reference in the pipe definition. The path limits the set of files to load." + }, + { + "key": "modified_after", + "value": "", + "description": "Timestamp (in ISO-8601 format) of the oldest data files to copy into the Snowpipe ingest queue based on the LAST_MODIFIED date (i.e. date when a file was staged)" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/{{name}}:refresh?ifExists=false&prefix=&modified_after=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + "{{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." + }, + { + "key": "prefix", + "value": "", + "description": "Path (or prefix) appended to the stage reference in the pipe definition. The path limits the set of files to load." + }, + { + "key": "modified_after", + "value": "", + "description": "Timestamp (in ISO-8601 format) of the oldest data files to copy into the Snowpipe ingest queue based on the LAST_MODIFIED date (i.e. date when a file was staged)" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/{{name}}:refresh?ifExists=false&prefix=&modified_after=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + "{{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." + }, + { + "key": "prefix", + "value": "", + "description": "Path (or prefix) appended to the stage reference in the pipe definition. The path limits the set of files to load." + }, + { + "key": "modified_after", + "value": "", + "description": "Timestamp (in ISO-8601 format) of the oldest data files to copy into the Snowpipe ingest queue based on the LAST_MODIFIED date (i.e. date when a file was staged)" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/{{name}}:refresh?ifExists=false&prefix=&modified_after=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + "{{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." + }, + { + "key": "prefix", + "value": "", + "description": "Path (or prefix) appended to the stage reference in the pipe definition. The path limits the set of files to load." + }, + { + "key": "modified_after", + "value": "", + "description": "Timestamp (in ISO-8601 format) of the oldest data files to copy into the Snowpipe ingest queue based on the LAST_MODIFIED date (i.e. date when a file was staged)" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/{{name}}:refresh?ifExists=false&prefix=&modified_after=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + "{{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." + }, + { + "key": "prefix", + "value": "", + "description": "Path (or prefix) appended to the stage reference in the pipe definition. The path limits the set of files to load." + }, + { + "key": "modified_after", + "value": "", + "description": "Timestamp (in ISO-8601 format) of the oldest data files to copy into the Snowpipe ingest queue based on the LAST_MODIFIED date (i.e. date when a file was staged)" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/{{name}}:refresh?ifExists=false&prefix=&modified_after=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + "{{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." + }, + { + "key": "prefix", + "value": "", + "description": "Path (or prefix) appended to the stage reference in the pipe definition. The path limits the set of files to load." + }, + { + "key": "modified_after", + "value": "", + "description": "Timestamp (in ISO-8601 format) of the oldest data files to copy into the Snowpipe ingest queue based on the LAST_MODIFIED date (i.e. date when a file was staged)" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/{{name}}:refresh?ifExists=false&prefix=&modified_after=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + "{{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." + }, + { + "key": "prefix", + "value": "", + "description": "Path (or prefix) appended to the stage reference in the pipe definition. The path limits the set of files to load." + }, + { + "key": "modified_after", + "value": "", + "description": "Timestamp (in ISO-8601 format) of the oldest data files to copy into the Snowpipe ingest queue based on the LAST_MODIFIED date (i.e. date when a file was staged)" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/{{name}}:refresh?ifExists=false&prefix=&modified_after=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + "{{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." + }, + { + "key": "prefix", + "value": "", + "description": "Path (or prefix) appended to the stage reference in the pipe definition. The path limits the set of files to load." + }, + { + "key": "modified_after", + "value": "", + "description": "Timestamp (in ISO-8601 format) of the oldest data files to copy into the Snowpipe ingest queue based on the LAST_MODIFIED date (i.e. date when a file was staged)" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/{{name}}:refresh?ifExists=false&prefix=&modified_after=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + "{{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." + }, + { + "key": "prefix", + "value": "", + "description": "Path (or prefix) appended to the stage reference in the pipe definition. The path limits the set of files to load." + }, + { + "key": "modified_after", + "value": "", + "description": "Timestamp (in ISO-8601 format) of the oldest data files to copy into the Snowpipe ingest queue based on the LAST_MODIFIED date (i.e. date when a file was staged)" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/{{name}}:refresh?ifExists=false&prefix=&modified_after=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + "{{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." + }, + { + "key": "prefix", + "value": "", + "description": "Path (or prefix) appended to the stage reference in the pipe definition. The path limits the set of files to load." + }, + { + "key": "modified_after", + "value": "", + "description": "Timestamp (in ISO-8601 format) of the oldest data files to copy into the Snowpipe ingest queue based on the LAST_MODIFIED date (i.e. date when a file was staged)" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/{{name}}:refresh?ifExists=false&prefix=&modified_after=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + "{{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." + }, + { + "key": "prefix", + "value": "", + "description": "Path (or prefix) appended to the stage reference in the pipe definition. The path limits the set of files to load." + }, + { + "key": "modified_after", + "value": "", + "description": "Timestamp (in ISO-8601 format) of the oldest data files to copy into the Snowpipe ingest queue based on the LAST_MODIFIED date (i.e. date when a file was staged)" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/{{name}}:refresh?ifExists=false&prefix=&modified_after=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + "{{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." + }, + { + "key": "prefix", + "value": "", + "description": "Path (or prefix) appended to the stage reference in the pipe definition. The path limits the set of files to load." + }, + { + "key": "modified_after", + "value": "", + "description": "Timestamp (in ISO-8601 format) of the oldest data files to copy into the Snowpipe ingest queue based on the LAST_MODIFIED date (i.e. date when a file was staged)" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes/{{name}}:refresh?ifExists=false&prefix=&modified_after=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes", + "{{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." + }, + { + "key": "prefix", + "value": "", + "description": "Path (or prefix) appended to the stage reference in the pipe definition. The path limits the set of files to load." + }, + { + "key": "modified_after", + "value": "", + "description": "Timestamp (in ISO-8601 format) of the oldest data files to copy into the Snowpipe ingest queue based on the LAST_MODIFIED date (i.e. date when a file was staged)" + } + ], + "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 pipes", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes" + ], + "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": "\"\"\"\"\"\"\"@hF\"", + "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": "\"\"\"\"\"\"\"@hF\"", + "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": "List pipes" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes" + ], + "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": "null" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes" + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes" + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes" + ], + "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": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes" + ], + "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": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes" + ], + "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 pipe", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "null", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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": "\"\"\"\"\"\"\"@hF\"", + "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": "\"\"\"\"\"\"\"@hF\"", + "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 pipe" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "null", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "null", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "null", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "null", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "null", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "null", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "null", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "null", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "null", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "null", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "null", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "null", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "null", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "null", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/pipes?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "pipes" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + }, + { + "key": "name", + "value": "\"\"\"\"\"\"\"@hF\"" + } + ] +} \ No newline at end of file diff --git a/releases/8.40/collections/Snowflake Procedure API.postman_collection.json b/releases/8.40/collections/Snowflake Procedure API.postman_collection.json new file mode 100644 index 0000000..4e8351a --- /dev/null +++ b/releases/8.40/collections/Snowflake Procedure API.postman_collection.json @@ -0,0 +1,5429 @@ +{ + "info": { + "_postman_id": "c8f35774-9794-4045-a241-6c9852a92472", + "name": "Snowflake Procedure API", + "description": "The Snowflake Procedure API is a REST API that you can use to access, update, and perform certain actions on Procedure 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" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "databases", + "item": [ + { + "name": "{database}", + "item": [ + { + "name": "schemas", + "item": [ + { + "name": "{schema}", + "item": [ + { + "name": "procedures", + "item": [ + { + "name": "{nameWithArgs}", + "item": [ + { + "name": "Fetch a procedure", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + ":nameWithArgs" + ], + "variable": [ + { + "key": "database", + "value": "Mq2vd8Ng", + "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": "Mq2vd8Ng", + "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 procedure" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + ":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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"name\": \"\\\"O$\\\"\",\n \"arguments\": [\n {\n \"name\": \"iRzpR7sJ8D\",\n \"datatype\": \"TIMESTAMP_LTZ\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"HH9mgOy0eMW\",\n \"datatype\": \"DOUBLE PRECISION\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"o\\\"\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\"\n },\n \"body\": \"\",\n \"execute_as\": \"OWNER\",\n \"is_secure\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"schema_name\": \"Nnc65Qm6a\",\n \"database_name\": \"X_cpIEDu\",\n \"min_num_arguments\": \"\",\n \"max_num_arguments\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"is_builtin\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + ":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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + ":nameWithArgs" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "nameWithArgs" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + ":nameWithArgs" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "nameWithArgs" + } + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + ":nameWithArgs" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "nameWithArgs" + } + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + ":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 procedure", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + ":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": "Mq2vd8Ng", + "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": "Mq2vd8Ng", + "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 procedure" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + ":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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + ":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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + ":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": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + ":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": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + ":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": "{nameWithArgs}:call", + "item": [ + { + "name": "Call a procedure", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"call_arguments\": [\n {\n \"name\": \"\\\"w5\\\"\\\"(\\\"\\\"\\\"\\\"\\\"\",\n \"datatype\": \"NUMBER\",\n \"value\": {\n \"description\": \"Value of the call argument\"\n }\n },\n {\n \"name\": \"c6wXb0x\",\n \"datatype\": \"REAL\",\n \"value\": {\n \"description\": \"Value of the call argument\"\n }\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/{{nameWithArgs}}:call", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + "{{nameWithArgs}}:call" + ], + "variable": [ + { + "key": "database", + "value": "Mq2vd8Ng", + "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": "Mq2vd8Ng", + "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": "Call a procedure" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"call_arguments\": [\n {\n \"name\": \"\\\"w5\\\"\\\"(\\\"\\\"\\\"\\\"\\\"\",\n \"datatype\": \"NUMBER\",\n \"value\": {\n \"description\": \"Value of the call argument\"\n }\n },\n {\n \"name\": \"c6wXb0x\",\n \"datatype\": \"REAL\",\n \"value\": {\n \"description\": \"Value of the call argument\"\n }\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/{{nameWithArgs}}:call", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + "{{nameWithArgs}}:call" + ], + "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" + } + }, + { + "key": "Link", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"call_arguments\": [\n {\n \"name\": \"\\\"w5\\\"\\\"(\\\"\\\"\\\"\\\"\\\"\",\n \"datatype\": \"NUMBER\",\n \"value\": {\n \"description\": \"Value of the call argument\"\n }\n },\n {\n \"name\": \"c6wXb0x\",\n \"datatype\": \"REAL\",\n \"value\": {\n \"description\": \"Value of the call argument\"\n }\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/{{nameWithArgs}}:call", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + "{{nameWithArgs}}:call" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"call_arguments\": [\n {\n \"name\": \"\\\"w5\\\"\\\"(\\\"\\\"\\\"\\\"\\\"\",\n \"datatype\": \"NUMBER\",\n \"value\": {\n \"description\": \"Value of the call argument\"\n }\n },\n {\n \"name\": \"c6wXb0x\",\n \"datatype\": \"REAL\",\n \"value\": {\n \"description\": \"Value of the call argument\"\n }\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/{{nameWithArgs}}:call", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + "{{nameWithArgs}}:call" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"call_arguments\": [\n {\n \"name\": \"\\\"w5\\\"\\\"(\\\"\\\"\\\"\\\"\\\"\",\n \"datatype\": \"NUMBER\",\n \"value\": {\n \"description\": \"Value of the call argument\"\n }\n },\n {\n \"name\": \"c6wXb0x\",\n \"datatype\": \"REAL\",\n \"value\": {\n \"description\": \"Value of the call argument\"\n }\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/{{nameWithArgs}}:call", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + "{{nameWithArgs}}:call" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"call_arguments\": [\n {\n \"name\": \"\\\"w5\\\"\\\"(\\\"\\\"\\\"\\\"\\\"\",\n \"datatype\": \"NUMBER\",\n \"value\": {\n \"description\": \"Value of the call argument\"\n }\n },\n {\n \"name\": \"c6wXb0x\",\n \"datatype\": \"REAL\",\n \"value\": {\n \"description\": \"Value of the call argument\"\n }\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/{{nameWithArgs}}:call", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + "{{nameWithArgs}}:call" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"call_arguments\": [\n {\n \"name\": \"\\\"w5\\\"\\\"(\\\"\\\"\\\"\\\"\\\"\",\n \"datatype\": \"NUMBER\",\n \"value\": {\n \"description\": \"Value of the call argument\"\n }\n },\n {\n \"name\": \"c6wXb0x\",\n \"datatype\": \"REAL\",\n \"value\": {\n \"description\": \"Value of the call argument\"\n }\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/{{nameWithArgs}}:call", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + "{{nameWithArgs}}:call" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"call_arguments\": [\n {\n \"name\": \"\\\"w5\\\"\\\"(\\\"\\\"\\\"\\\"\\\"\",\n \"datatype\": \"NUMBER\",\n \"value\": {\n \"description\": \"Value of the call argument\"\n }\n },\n {\n \"name\": \"c6wXb0x\",\n \"datatype\": \"REAL\",\n \"value\": {\n \"description\": \"Value of the call argument\"\n }\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/{{nameWithArgs}}:call", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + "{{nameWithArgs}}:call" + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"call_arguments\": [\n {\n \"name\": \"\\\"w5\\\"\\\"(\\\"\\\"\\\"\\\"\\\"\",\n \"datatype\": \"NUMBER\",\n \"value\": {\n \"description\": \"Value of the call argument\"\n }\n },\n {\n \"name\": \"c6wXb0x\",\n \"datatype\": \"REAL\",\n \"value\": {\n \"description\": \"Value of the call argument\"\n }\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/{{nameWithArgs}}:call", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + "{{nameWithArgs}}:call" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"call_arguments\": [\n {\n \"name\": \"\\\"w5\\\"\\\"(\\\"\\\"\\\"\\\"\\\"\",\n \"datatype\": \"NUMBER\",\n \"value\": {\n \"description\": \"Value of the call argument\"\n }\n },\n {\n \"name\": \"c6wXb0x\",\n \"datatype\": \"REAL\",\n \"value\": {\n \"description\": \"Value of the call argument\"\n }\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/{{nameWithArgs}}:call", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + "{{nameWithArgs}}:call" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"call_arguments\": [\n {\n \"name\": \"\\\"w5\\\"\\\"(\\\"\\\"\\\"\\\"\\\"\",\n \"datatype\": \"NUMBER\",\n \"value\": {\n \"description\": \"Value of the call argument\"\n }\n },\n {\n \"name\": \"c6wXb0x\",\n \"datatype\": \"REAL\",\n \"value\": {\n \"description\": \"Value of the call argument\"\n }\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/{{nameWithArgs}}:call", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + "{{nameWithArgs}}:call" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"call_arguments\": [\n {\n \"name\": \"\\\"w5\\\"\\\"(\\\"\\\"\\\"\\\"\\\"\",\n \"datatype\": \"NUMBER\",\n \"value\": {\n \"description\": \"Value of the call argument\"\n }\n },\n {\n \"name\": \"c6wXb0x\",\n \"datatype\": \"REAL\",\n \"value\": {\n \"description\": \"Value of the call argument\"\n }\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/{{nameWithArgs}}:call", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + "{{nameWithArgs}}:call" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"call_arguments\": [\n {\n \"name\": \"\\\"w5\\\"\\\"(\\\"\\\"\\\"\\\"\\\"\",\n \"datatype\": \"NUMBER\",\n \"value\": {\n \"description\": \"Value of the call argument\"\n }\n },\n {\n \"name\": \"c6wXb0x\",\n \"datatype\": \"REAL\",\n \"value\": {\n \"description\": \"Value of the call argument\"\n }\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/{{nameWithArgs}}:call", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + "{{nameWithArgs}}:call" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"call_arguments\": [\n {\n \"name\": \"\\\"w5\\\"\\\"(\\\"\\\"\\\"\\\"\\\"\",\n \"datatype\": \"NUMBER\",\n \"value\": {\n \"description\": \"Value of the call argument\"\n }\n },\n {\n \"name\": \"c6wXb0x\",\n \"datatype\": \"REAL\",\n \"value\": {\n \"description\": \"Value of the call argument\"\n }\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/{{nameWithArgs}}:call", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + "{{nameWithArgs}}:call" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"call_arguments\": [\n {\n \"name\": \"\\\"w5\\\"\\\"(\\\"\\\"\\\"\\\"\\\"\",\n \"datatype\": \"NUMBER\",\n \"value\": {\n \"description\": \"Value of the call argument\"\n }\n },\n {\n \"name\": \"c6wXb0x\",\n \"datatype\": \"REAL\",\n \"value\": {\n \"description\": \"Value of the call argument\"\n }\n }\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures/{{nameWithArgs}}:call", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures", + "{{nameWithArgs}}:call" + ], + "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 procedures", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures" + ], + "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": "Mq2vd8Ng", + "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": "Mq2vd8Ng", + "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": "List procedures" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures" + ], + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"\\\"O\\\"\\\"\\\"\\\"=\\\"\\\"Y\\\"\\\"o\\\"\",\n \"arguments\": [\n {\n \"name\": \"\\\";\\\"\\\"V\\\"\\\"'\\\"\",\n \"datatype\": \"VARBINARY\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"FaN$NZ8cj\",\n \"datatype\": \"TIMESTAMP_NTZ\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"FkfJ7IDh\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\"\n },\n \"body\": \"\",\n \"execute_as\": \"OWNER\",\n \"is_secure\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"schema_name\": \"quV8b\",\n \"database_name\": \"E7\",\n \"min_num_arguments\": \"\",\n \"max_num_arguments\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"is_builtin\": \"\"\n },\n {\n \"name\": \"_60AKXg5t\",\n \"arguments\": [\n {\n \"name\": \"\\\"g\\\"\",\n \"datatype\": \"FLOAT\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"F1H$\",\n \"datatype\": \"CHARACTER\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"\\\",\\\"\\\"B\\\"\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\"\n },\n \"body\": \"\",\n \"execute_as\": \"OWNER\",\n \"is_secure\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"schema_name\": \"\\\"Z\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database_name\": \"\\\"G\\\"\\\"^\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"min_num_arguments\": \"\",\n \"max_num_arguments\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"is_builtin\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures" + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures" + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures" + ], + "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": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures" + ], + "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": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures" + ], + "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 procedure", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"G\\\"\\\"\\\"\\\",I1\\\"\",\n \"arguments\": [\n {\n \"name\": \"I6qEejTz2\",\n \"datatype\": \"STRING\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"y\\\"\\\"E\\\"\\\"\\\"\\\"\\\"\",\n \"datatype\": \"INT\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"\\\"v\\\"\\\" \\\"\\\"\\\"\\\"\\\"\\\"_A\\\"\\\"\\\"\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\"\n },\n \"body\": \"\",\n \"execute_as\": \"CALLER\",\n \"is_secure\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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": "Mq2vd8Ng", + "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": "Mq2vd8Ng", + "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 procedure" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"G\\\"\\\"\\\"\\\",I1\\\"\",\n \"arguments\": [\n {\n \"name\": \"I6qEejTz2\",\n \"datatype\": \"STRING\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"y\\\"\\\"E\\\"\\\"\\\"\\\"\\\"\",\n \"datatype\": \"INT\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"\\\"v\\\"\\\" \\\"\\\"\\\"\\\"\\\"\\\"_A\\\"\\\"\\\"\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\"\n },\n \"body\": \"\",\n \"execute_as\": \"CALLER\",\n \"is_secure\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"G\\\"\\\"\\\"\\\",I1\\\"\",\n \"arguments\": [\n {\n \"name\": \"I6qEejTz2\",\n \"datatype\": \"STRING\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"y\\\"\\\"E\\\"\\\"\\\"\\\"\\\"\",\n \"datatype\": \"INT\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"\\\"v\\\"\\\" \\\"\\\"\\\"\\\"\\\"\\\"_A\\\"\\\"\\\"\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\"\n },\n \"body\": \"\",\n \"execute_as\": \"CALLER\",\n \"is_secure\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"G\\\"\\\"\\\"\\\",I1\\\"\",\n \"arguments\": [\n {\n \"name\": \"I6qEejTz2\",\n \"datatype\": \"STRING\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"y\\\"\\\"E\\\"\\\"\\\"\\\"\\\"\",\n \"datatype\": \"INT\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"\\\"v\\\"\\\" \\\"\\\"\\\"\\\"\\\"\\\"_A\\\"\\\"\\\"\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\"\n },\n \"body\": \"\",\n \"execute_as\": \"CALLER\",\n \"is_secure\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"G\\\"\\\"\\\"\\\",I1\\\"\",\n \"arguments\": [\n {\n \"name\": \"I6qEejTz2\",\n \"datatype\": \"STRING\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"y\\\"\\\"E\\\"\\\"\\\"\\\"\\\"\",\n \"datatype\": \"INT\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"\\\"v\\\"\\\" \\\"\\\"\\\"\\\"\\\"\\\"_A\\\"\\\"\\\"\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\"\n },\n \"body\": \"\",\n \"execute_as\": \"CALLER\",\n \"is_secure\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"G\\\"\\\"\\\"\\\",I1\\\"\",\n \"arguments\": [\n {\n \"name\": \"I6qEejTz2\",\n \"datatype\": \"STRING\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"y\\\"\\\"E\\\"\\\"\\\"\\\"\\\"\",\n \"datatype\": \"INT\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"\\\"v\\\"\\\" \\\"\\\"\\\"\\\"\\\"\\\"_A\\\"\\\"\\\"\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\"\n },\n \"body\": \"\",\n \"execute_as\": \"CALLER\",\n \"is_secure\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"G\\\"\\\"\\\"\\\",I1\\\"\",\n \"arguments\": [\n {\n \"name\": \"I6qEejTz2\",\n \"datatype\": \"STRING\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"y\\\"\\\"E\\\"\\\"\\\"\\\"\\\"\",\n \"datatype\": \"INT\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"\\\"v\\\"\\\" \\\"\\\"\\\"\\\"\\\"\\\"_A\\\"\\\"\\\"\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\"\n },\n \"body\": \"\",\n \"execute_as\": \"CALLER\",\n \"is_secure\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"G\\\"\\\"\\\"\\\",I1\\\"\",\n \"arguments\": [\n {\n \"name\": \"I6qEejTz2\",\n \"datatype\": \"STRING\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"y\\\"\\\"E\\\"\\\"\\\"\\\"\\\"\",\n \"datatype\": \"INT\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"\\\"v\\\"\\\" \\\"\\\"\\\"\\\"\\\"\\\"_A\\\"\\\"\\\"\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\"\n },\n \"body\": \"\",\n \"execute_as\": \"CALLER\",\n \"is_secure\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"G\\\"\\\"\\\"\\\",I1\\\"\",\n \"arguments\": [\n {\n \"name\": \"I6qEejTz2\",\n \"datatype\": \"STRING\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"y\\\"\\\"E\\\"\\\"\\\"\\\"\\\"\",\n \"datatype\": \"INT\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"\\\"v\\\"\\\" \\\"\\\"\\\"\\\"\\\"\\\"_A\\\"\\\"\\\"\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\"\n },\n \"body\": \"\",\n \"execute_as\": \"CALLER\",\n \"is_secure\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"G\\\"\\\"\\\"\\\",I1\\\"\",\n \"arguments\": [\n {\n \"name\": \"I6qEejTz2\",\n \"datatype\": \"STRING\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"y\\\"\\\"E\\\"\\\"\\\"\\\"\\\"\",\n \"datatype\": \"INT\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"\\\"v\\\"\\\" \\\"\\\"\\\"\\\"\\\"\\\"_A\\\"\\\"\\\"\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\"\n },\n \"body\": \"\",\n \"execute_as\": \"CALLER\",\n \"is_secure\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"G\\\"\\\"\\\"\\\",I1\\\"\",\n \"arguments\": [\n {\n \"name\": \"I6qEejTz2\",\n \"datatype\": \"STRING\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"y\\\"\\\"E\\\"\\\"\\\"\\\"\\\"\",\n \"datatype\": \"INT\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"\\\"v\\\"\\\" \\\"\\\"\\\"\\\"\\\"\\\"_A\\\"\\\"\\\"\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\"\n },\n \"body\": \"\",\n \"execute_as\": \"CALLER\",\n \"is_secure\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"G\\\"\\\"\\\"\\\",I1\\\"\",\n \"arguments\": [\n {\n \"name\": \"I6qEejTz2\",\n \"datatype\": \"STRING\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"y\\\"\\\"E\\\"\\\"\\\"\\\"\\\"\",\n \"datatype\": \"INT\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"\\\"v\\\"\\\" \\\"\\\"\\\"\\\"\\\"\\\"_A\\\"\\\"\\\"\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\"\n },\n \"body\": \"\",\n \"execute_as\": \"CALLER\",\n \"is_secure\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"G\\\"\\\"\\\"\\\",I1\\\"\",\n \"arguments\": [\n {\n \"name\": \"I6qEejTz2\",\n \"datatype\": \"STRING\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"y\\\"\\\"E\\\"\\\"\\\"\\\"\\\"\",\n \"datatype\": \"INT\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"\\\"v\\\"\\\" \\\"\\\"\\\"\\\"\\\"\\\"_A\\\"\\\"\\\"\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\"\n },\n \"body\": \"\",\n \"execute_as\": \"CALLER\",\n \"is_secure\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"G\\\"\\\"\\\"\\\",I1\\\"\",\n \"arguments\": [\n {\n \"name\": \"I6qEejTz2\",\n \"datatype\": \"STRING\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"y\\\"\\\"E\\\"\\\"\\\"\\\"\\\"\",\n \"datatype\": \"INT\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"\\\"v\\\"\\\" \\\"\\\"\\\"\\\"\\\"\\\"_A\\\"\\\"\\\"\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\"\n },\n \"body\": \"\",\n \"execute_as\": \"CALLER\",\n \"is_secure\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"G\\\"\\\"\\\"\\\",I1\\\"\",\n \"arguments\": [\n {\n \"name\": \"I6qEejTz2\",\n \"datatype\": \"STRING\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"y\\\"\\\"E\\\"\\\"\\\"\\\"\\\"\",\n \"datatype\": \"INT\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"\\\"v\\\"\\\" \\\"\\\"\\\"\\\"\\\"\\\"_A\\\"\\\"\\\"\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\"\n },\n \"body\": \"\",\n \"execute_as\": \"CALLER\",\n \"is_secure\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/procedures?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "procedures" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + }, + { + "key": "nameWithArgs", + "value": "" + } + ] +} \ No newline at end of file diff --git a/releases/8.40/collections/Snowflake Result API.postman_collection.json b/releases/8.40/collections/Snowflake Result API.postman_collection.json new file mode 100644 index 0000000..6a52fb4 --- /dev/null +++ b/releases/8.40/collections/Snowflake Result API.postman_collection.json @@ -0,0 +1,824 @@ +{ + "info": { + "_postman_id": "b86ee293-d97e-424c-874b-0ff8a93021dc", + "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" + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + } + ] +} \ No newline at end of file diff --git a/releases/8.40/collections/Snowflake Role API.postman_collection.json b/releases/8.40/collections/Snowflake Role API.postman_collection.json new file mode 100644 index 0000000..007bec5 --- /dev/null +++ b/releases/8.40/collections/Snowflake Role API.postman_collection.json @@ -0,0 +1,10897 @@ +{ + "info": { + "_postman_id": "6a368e53-5cc8-4dfa-ab6f-d8fa7e6c705f", + "name": "Snowflake Role API", + "description": "The Snowflake Role API is a REST API that you can use to access, update, and perform certain actions on Role 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" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "roles", + "item": [ + { + "name": "{name}", + "item": [ + { + "name": "grants", + "item": [ + { + "name": "List all grants to the role", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "variable": [ + { + "key": "name", + "value": "Il", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "List all grants to the role" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"poZq\",\n \"database\": \"eIr0mmBqRZ\",\n \"schema\": \"Mm0pE0uGH\",\n \"service\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\\\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"6>\\\"\\\"\\\"\\\"$\\\"\\\"K\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"\\\"\\\"\\\"\\\"\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"created_on\": \"\",\n \"granted_by\": \"\"\n },\n {\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"1\\\"\\\"[\\\"\\\"/=h\\\"\",\n \"database\": \"Co\",\n \"schema\": \"OFJLDjvnP\",\n \"service\": \"\\\"\\\"\\\"C98\\\"\\\"\\\"\\\"\\\"\\\"o\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"GfD\",\n \"schema\": \"O7O\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"created_on\": \"\",\n \"granted_by\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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": "Grant privileges to the role", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants" + ], + "variable": [ + { + "key": "name", + "value": "Il", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Grant privileges to the role" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants" + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants" + ], + "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": "grants:revoke", + "item": [ + { + "name": "Revoke grants from the role", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants:revoke?mode=restrict", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "restrict", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "variable": [ + { + "key": "name", + "value": "Il", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Revoke grants from the role" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants:revoke?mode=restrict", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "restrict", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants:revoke?mode=restrict", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "restrict", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants:revoke?mode=restrict", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "restrict", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants:revoke?mode=restrict", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "restrict", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants:revoke?mode=restrict", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "restrict", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants:revoke?mode=restrict", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "restrict", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants:revoke?mode=restrict", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "restrict", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants:revoke?mode=restrict", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "restrict", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants:revoke?mode=restrict", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "restrict", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants:revoke?mode=restrict", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "restrict", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants:revoke?mode=restrict", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "restrict", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants:revoke?mode=restrict", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "restrict", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants:revoke?mode=restrict", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "restrict", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants:revoke?mode=restrict", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "restrict", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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": "grants-of", + "item": [ + { + "name": "List all grants of the role", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants-of?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants-of" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "variable": [ + { + "key": "name", + "value": "Il", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "List all grants of the role" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants-of?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants-of" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"created_on\": \"\",\n \"role\": \"\",\n \"granted_to\": \"\",\n \"grantee_name\": \"\",\n \"granted_by\": \"\"\n },\n {\n \"created_on\": \"\",\n \"role\": \"\",\n \"granted_to\": \"\",\n \"grantee_name\": \"\",\n \"granted_by\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants-of?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants-of" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants-of?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants-of" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants-of?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants-of" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants-of?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants-of" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants-of?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants-of" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants-of?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants-of" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants-of?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants-of" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants-of?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants-of" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants-of?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants-of" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants-of?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants-of" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants-of?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants-of" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants-of?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants-of" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants-of?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants-of" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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": "grants-on", + "item": [ + { + "name": "List all grants on the role", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants-on?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants-on" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "variable": [ + { + "key": "name", + "value": "Il", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "List all grants on the role" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants-on?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants-on" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"created_on\": \"\",\n \"privilege\": \"\",\n \"granted_on\": \"\",\n \"name\": \"\",\n \"granted_to\": \"\",\n \"grantee_name\": \"\",\n \"grant_option\": \"\",\n \"granted_by\": \"\",\n \"granted_by_role_type\": \"\"\n },\n {\n \"created_on\": \"\",\n \"privilege\": \"\",\n \"granted_on\": \"\",\n \"name\": \"\",\n \"granted_to\": \"\",\n \"grantee_name\": \"\",\n \"grant_option\": \"\",\n \"granted_by\": \"\",\n \"granted_by_role_type\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants-on?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants-on" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants-on?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants-on" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants-on?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants-on" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants-on?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants-on" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants-on?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants-on" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants-on?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants-on" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants-on?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants-on" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants-on?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants-on" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants-on?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants-on" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants-on?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants-on" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants-on?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants-on" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants-on?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants-on" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/grants-on?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "grants-on" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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": "future-grants", + "item": [ + { + "name": "List all future grants to the role", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "variable": [ + { + "key": "name", + "value": "Il", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "List all future grants to the role" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"poZq\",\n \"database\": \"eIr0mmBqRZ\",\n \"schema\": \"Mm0pE0uGH\",\n \"service\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\\\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"6>\\\"\\\"\\\"\\\"$\\\"\\\"K\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"\\\"\\\"\\\"\\\"\\\"\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"created_on\": \"\",\n \"granted_by\": \"\"\n },\n {\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"1\\\"\\\"[\\\"\\\"/=h\\\"\",\n \"database\": \"Co\",\n \"schema\": \"OFJLDjvnP\",\n \"service\": \"\\\"\\\"\\\"C98\\\"\\\"\\\"\\\"\\\"\\\"o\\\"\\\"\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"GfD\",\n \"schema\": \"O7O\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"created_on\": \"\",\n \"granted_by\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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": "Grant future privileges to the role", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants" + ], + "variable": [ + { + "key": "name", + "value": "Il", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Grant future privileges to the role" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants" + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants" + ], + "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": "future-grants:revoke", + "item": [ + { + "name": "Revoke future grants from the role", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants:revoke?mode=restrict", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "restrict", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "variable": [ + { + "key": "name", + "value": "Il", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Revoke future grants from the role" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants:revoke?mode=restrict", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "restrict", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants:revoke?mode=restrict", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "restrict", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants:revoke?mode=restrict", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "restrict", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants:revoke?mode=restrict", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "restrict", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants:revoke?mode=restrict", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "restrict", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants:revoke?mode=restrict", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "restrict", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants:revoke?mode=restrict", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "restrict", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants:revoke?mode=restrict", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "restrict", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants:revoke?mode=restrict", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "restrict", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants:revoke?mode=restrict", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "restrict", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants:revoke?mode=restrict", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "restrict", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants:revoke?mode=restrict", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "restrict", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants:revoke?mode=restrict", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "restrict", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"E9o857\",\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\\\"=n\\\"\",\n \"schema\": \"L9Qu66Ff\",\n \"service\": \"_\"\n },\n \"containing_scope\": {\n \"database\": \"d95n\",\n \"schema\": \"h3hBsg\"\n },\n \"grant_option\": \"\",\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/roles/:name/future-grants:revoke?mode=restrict", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "roles", + ":name", + "future-grants:revoke" + ], + "query": [ + { + "key": "mode", + "value": "restrict", + "description": "Query parameter determines whether the revoke operation succeeds or fails for the privileges, based on the whether the privileges had been re-granted to another role.\n- restrict: If the privilege being revoked has been re-granted to another role, the REVOKE command fails.\n- cascade: If the privilege being revoked has been re-granted, the REVOKE command recursively revokes these dependent grants. If the same privilege on an object has been granted to the target role by a different grantor (parallel grant), that grant is not affected and the target role retains the privilege." + } + ], + "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 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": "Il", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Delete a role" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "List roles", + "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": "List roles" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"UtRiHghZk\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"owner\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"Hc\\\"\\\";@c\\\"\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"is_inherited\": \"\",\n \"assigned_to_users\": \"\",\n \"granted_to_roles\": \"\",\n \"granted_roles\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\" S\\\"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"owner\": \"ndd$rxWjde\",\n \"is_default\": \"\",\n \"is_current\": \"\",\n \"is_inherited\": \"\",\n \"assigned_to_users\": \"\",\n \"granted_to_roles\": \"\",\n \"granted_roles\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}" + } + ] + }, + { + "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\": \"R9VHrCi$\",\n \"comment\": \"\"\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" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"R9VHrCi$\",\n \"comment\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"R9VHrCi$\",\n \"comment\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"R9VHrCi$\",\n \"comment\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"R9VHrCi$\",\n \"comment\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"R9VHrCi$\",\n \"comment\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"R9VHrCi$\",\n \"comment\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"R9VHrCi$\",\n \"comment\": \"\"\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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"R9VHrCi$\",\n \"comment\": \"\"\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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"R9VHrCi$\",\n \"comment\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"R9VHrCi$\",\n \"comment\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"R9VHrCi$\",\n \"comment\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"R9VHrCi$\",\n \"comment\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"R9VHrCi$\",\n \"comment\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"R9VHrCi$\",\n \"comment\": \"\"\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}" + } + ] + } + ] + } + ] + } + ] + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + } + ] +} \ No newline at end of file diff --git a/releases/8.40/collections/Snowflake Schema API.postman_collection.json b/releases/8.40/collections/Snowflake Schema API.postman_collection.json new file mode 100644 index 0000000..e746750 --- /dev/null +++ b/releases/8.40/collections/Snowflake Schema API.postman_collection.json @@ -0,0 +1,7651 @@ +{ + "info": { + "_postman_id": "3e18bb71-2a74-4c25-b20f-f4b56e7a23a1", + "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" + }, + "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\": \"FQt4ho\",\n \"point_of_time\": {\n \"point_of_time_type\": \"magna fugiat\",\n \"reference\": \"enim sint ut\"\n },\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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=R", + "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": "R", + "description": "Database of the newly created schema. Defaults to the source schema's database." + } + ], + "variable": [ + { + "key": "database", + "value": "R", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"FQt4ho\",\n \"point_of_time\": {\n \"point_of_time_type\": \"magna fugiat\",\n \"reference\": \"enim sint ut\"\n },\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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=R", + "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": "R", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"FQt4ho\",\n \"point_of_time\": {\n \"point_of_time_type\": \"magna fugiat\",\n \"reference\": \"enim sint ut\"\n },\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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=R", + "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": "R", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"FQt4ho\",\n \"point_of_time\": {\n \"point_of_time_type\": \"magna fugiat\",\n \"reference\": \"enim sint ut\"\n },\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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=R", + "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": "R", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"FQt4ho\",\n \"point_of_time\": {\n \"point_of_time_type\": \"magna fugiat\",\n \"reference\": \"enim sint ut\"\n },\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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=R", + "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": "R", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"FQt4ho\",\n \"point_of_time\": {\n \"point_of_time_type\": \"magna fugiat\",\n \"reference\": \"enim sint ut\"\n },\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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=R", + "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": "R", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"FQt4ho\",\n \"point_of_time\": {\n \"point_of_time_type\": \"magna fugiat\",\n \"reference\": \"enim sint ut\"\n },\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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=R", + "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": "R", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"FQt4ho\",\n \"point_of_time\": {\n \"point_of_time_type\": \"magna fugiat\",\n \"reference\": \"enim sint ut\"\n },\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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=R", + "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": "R", + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"FQt4ho\",\n \"point_of_time\": {\n \"point_of_time_type\": \"magna fugiat\",\n \"reference\": \"enim sint ut\"\n },\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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=R", + "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": "R", + "description": "Database of the newly created schema. Defaults to the source schema's database." + } + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"FQt4ho\",\n \"point_of_time\": {\n \"point_of_time_type\": \"magna fugiat\",\n \"reference\": \"enim sint ut\"\n },\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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=R", + "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": "R", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"FQt4ho\",\n \"point_of_time\": {\n \"point_of_time_type\": \"magna fugiat\",\n \"reference\": \"enim sint ut\"\n },\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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=R", + "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": "R", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"FQt4ho\",\n \"point_of_time\": {\n \"point_of_time_type\": \"magna fugiat\",\n \"reference\": \"enim sint ut\"\n },\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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=R", + "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": "R", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"FQt4ho\",\n \"point_of_time\": {\n \"point_of_time_type\": \"magna fugiat\",\n \"reference\": \"enim sint ut\"\n },\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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=R", + "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": "R", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"FQt4ho\",\n \"point_of_time\": {\n \"point_of_time_type\": \"magna fugiat\",\n \"reference\": \"enim sint ut\"\n },\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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=R", + "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": "R", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"FQt4ho\",\n \"point_of_time\": {\n \"point_of_time_type\": \"magna fugiat\",\n \"reference\": \"enim sint ut\"\n },\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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=R", + "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": "R", + "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": "R", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/{{name}}:undrop", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + "{{name}}:undrop" + ], + "variable": [ + { + "key": "database" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "R", + "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": "R", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"name\": \"E0lfK6G\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"\\\"M\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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": "R", + "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": "R", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"M\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"M\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"M\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"M\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"M\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"M\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"M\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"M\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"M\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"M\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"M\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"M\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"M\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"M\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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": "R", + "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": "R", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "R", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"\\\"a#\\\"\\\"\\\"\\\"\\\"\\\"K1\\\"\\\"\\\"\",\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\": \"a19Um7dVau\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"\\\"M\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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": "R", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"M\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"M\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"M\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"M\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"M\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"M\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"M\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"M\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"M\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"M\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"M\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"M\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"M\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"M\\\"\",\n \"kind\": \"PERMANENT\",\n \"comment\": \"\",\n \"managed_access\": false,\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}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + }, + { + "key": "name", + "value": "R" + } + ] +} \ No newline at end of file diff --git a/releases/8.40/collections/Snowflake Services API.postman_collection.json b/releases/8.40/collections/Snowflake Services API.postman_collection.json new file mode 100644 index 0000000..783b354 --- /dev/null +++ b/releases/8.40/collections/Snowflake Services API.postman_collection.json @@ -0,0 +1,13755 @@ +{ + "info": { + "_postman_id": "66234771-77bc-4792-a582-f56644ad51c0", + "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" + }, + "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": "pRBL_r", + "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": "pRBL_r", + "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": "pRBL_r", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "pRBL_r", + "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": "pRBL_r", + "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": "pRBL_r", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "containers", + "item": [ + { + "name": "list Service Containers", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/containers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "containers" + ], + "variable": [ + { + "key": "database", + "value": "pRBL_r", + "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": "pRBL_r", + "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": "pRBL_r", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "List all the containers of the service" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/containers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "containers" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"database_name\": \"\\\"5\\\"\",\n \"schema_name\": \"CEUhZid7F41\",\n \"service_name\": \"\\\"9#C\\\"\\\"\\\"\\\"L\\\"\\\"\\\"\\\"r\\\"\\\"K\\\"\",\n \"instance_id\": \"\",\n \"container_name\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"image_name\": \"\",\n \"image_digest\": \"\",\n \"restart_count\": \"\",\n \"start_time\": \"\"\n },\n {\n \"database_name\": \"\\\"\\\"\\\"\\\"\\\"jsm\\\"\\\"\\\"\\\"u]E\\\"\",\n \"schema_name\": \"\\\"/\\\"\\\"\\\"\",\n \"service_name\": \"\\\"n;\\\"\\\"@n|\\\"\\\"\\\"\",\n \"instance_id\": \"\",\n \"container_name\": \"\",\n \"status\": \"\",\n \"message\": \"\",\n \"image_name\": \"\",\n \"image_digest\": \"\",\n \"restart_count\": \"\",\n \"start_time\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/containers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "containers" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/containers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "containers" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/containers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "containers" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/containers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "containers" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/containers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "containers" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/containers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "containers" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/containers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "containers" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/containers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "containers" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/containers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "containers" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/containers", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "containers" + ], + "variable": [ + { + "key": "database" + }, + { + "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": "instances", + "item": [ + { + "name": "list Service Instances", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/instances", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "instances" + ], + "variable": [ + { + "key": "database", + "value": "pRBL_r", + "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": "pRBL_r", + "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": "pRBL_r", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "List all the instances of the service" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/instances", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "instances" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"database_name\": \"bd8ZMK2nA\",\n \"schema_name\": \"mOTeRn2\",\n \"service_name\": \"\\\"\\\"\\\"\\\"\",\n \"instance_id\": \"\",\n \"status\": \"\",\n \"spec_digest\": \"\",\n \"creation_time\": \"\",\n \"start_time\": \"\"\n },\n {\n \"database_name\": \"\\\"\\\"\\\"\\\"\\\":@tC~\\\"\",\n \"schema_name\": \"QI4eztZ\",\n \"service_name\": \"\\\"\\\"\\\"^t\\\"\\\"\\\"\\\"gS\\\"\",\n \"instance_id\": \"\",\n \"status\": \"\",\n \"spec_digest\": \"\",\n \"creation_time\": \"\",\n \"start_time\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/instances", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "instances" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/instances", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "instances" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/instances", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "instances" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/instances", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "instances" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/instances", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "instances" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/instances", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "instances" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/instances", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "instances" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/instances", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "instances" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/instances", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "instances" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/instances", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "instances" + ], + "variable": [ + { + "key": "database" + }, + { + "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": "roles", + "item": [ + { + "name": "list Service Roles", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/roles", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "roles" + ], + "variable": [ + { + "key": "database", + "value": "pRBL_r", + "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": "pRBL_r", + "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": "pRBL_r", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "List all the service roles of the service" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/roles", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "roles" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"created_on\": \"\",\n \"name\": \"\",\n \"comment\": \"\"\n },\n {\n \"created_on\": \"\",\n \"name\": \"\",\n \"comment\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/roles", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "roles" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/roles", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "roles" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/roles", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "roles" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/roles", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "roles" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/roles", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "roles" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/roles", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "roles" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/roles", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "roles" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/roles", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "roles" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/roles", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "roles" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/roles", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "roles" + ], + "variable": [ + { + "key": "database" + }, + { + "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": "pRBL_r", + "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": "pRBL_r", + "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": "pRBL_r", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/endpoints", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "endpoints" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"\",\n \"port\": \"\",\n \"portRange\": \"\",\n \"protocol\": \"HTTP\",\n \"is_public\": false,\n \"ingress_url\": \"\"\n },\n {\n \"name\": \"\",\n \"port\": \"\",\n \"portRange\": \"\",\n \"protocol\": \"HTTP\",\n \"is_public\": false,\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/endpoints", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "endpoints" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/endpoints", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "endpoints" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/endpoints", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "endpoints" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/endpoints", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "endpoints" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/endpoints", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "endpoints" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/endpoints", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "endpoints" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/endpoints", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "endpoints" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/endpoints", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "endpoints" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/endpoints", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "endpoints" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name/endpoints", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name", + "endpoints" + ], + "variable": [ + { + "key": "database" + }, + { + "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": "pRBL_r", + "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": "pRBL_r", + "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": "pRBL_r", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"name\": \"\\\"\\\"\\\"'r=\\\"\",\n \"compute_pool\": \"\",\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"\\\"/e\\\"\\\"\\\"\\\"JU\\\"\\\"\\\"\",\n \"comment\": \"\",\n \"auto_resume\": \"\",\n \"current_instances\": \"\",\n \"target_instances\": \"\",\n \"min_ready_instances\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"database_name\": \"\\\"$;m\\\"\\\"?\\\"\\\"}\\\"\\\"\\\"\",\n \"schema_name\": \"G\",\n \"owner\": \"\",\n \"dns_name\": \"\",\n \"created_on\": \"\",\n \"updated_on\": \"\",\n \"resumed_on\": \"\",\n \"owner_role_type\": \"\",\n \"is_job\": \"\",\n \"spec_digest\": \"\",\n \"is_upgrading\": \"\",\n \"managing_object_domain\": \"\",\n \"managing_object_name\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "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) service.", + "request": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"u\\\"\\\" \\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"v/\\\"\\\"VC6\\\"\\\"\\\"\",\n \"comment\": \"\",\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"database_name\": \"UlUDDNpGynD\",\n \"schema_name\": \"Jfm\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "variable": [ + { + "key": "database", + "value": "pRBL_r", + "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": "pRBL_r", + "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": "pRBL_r", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Create a (or alter an existing) service. Even if the operation is just an alter, the full property set must be provided." + }, + "response": [ + { + "name": "Successful request", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"u\\\"\\\" \\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"v/\\\"\\\"VC6\\\"\\\"\\\"\",\n \"comment\": \"\",\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"database_name\": \"UlUDDNpGynD\",\n \"schema_name\": \"Jfm\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + } + }, + { + "key": "Link", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"u\\\"\\\" \\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"v/\\\"\\\"VC6\\\"\\\"\\\"\",\n \"comment\": \"\",\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"database_name\": \"UlUDDNpGynD\",\n \"schema_name\": \"Jfm\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"u\\\"\\\" \\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"v/\\\"\\\"VC6\\\"\\\"\\\"\",\n \"comment\": \"\",\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"database_name\": \"UlUDDNpGynD\",\n \"schema_name\": \"Jfm\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"u\\\"\\\" \\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"v/\\\"\\\"VC6\\\"\\\"\\\"\",\n \"comment\": \"\",\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"database_name\": \"UlUDDNpGynD\",\n \"schema_name\": \"Jfm\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"u\\\"\\\" \\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"v/\\\"\\\"VC6\\\"\\\"\\\"\",\n \"comment\": \"\",\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"database_name\": \"UlUDDNpGynD\",\n \"schema_name\": \"Jfm\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"u\\\"\\\" \\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"v/\\\"\\\"VC6\\\"\\\"\\\"\",\n \"comment\": \"\",\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"database_name\": \"UlUDDNpGynD\",\n \"schema_name\": \"Jfm\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"u\\\"\\\" \\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"v/\\\"\\\"VC6\\\"\\\"\\\"\",\n \"comment\": \"\",\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"database_name\": \"UlUDDNpGynD\",\n \"schema_name\": \"Jfm\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "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": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"u\\\"\\\" \\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"v/\\\"\\\"VC6\\\"\\\"\\\"\",\n \"comment\": \"\",\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"database_name\": \"UlUDDNpGynD\",\n \"schema_name\": \"Jfm\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"u\\\"\\\" \\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"v/\\\"\\\"VC6\\\"\\\"\\\"\",\n \"comment\": \"\",\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"database_name\": \"UlUDDNpGynD\",\n \"schema_name\": \"Jfm\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"u\\\"\\\" \\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"v/\\\"\\\"VC6\\\"\\\"\\\"\",\n \"comment\": \"\",\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"database_name\": \"UlUDDNpGynD\",\n \"schema_name\": \"Jfm\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "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": "pRBL_r", + "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": "pRBL_r", + "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": "pRBL_r", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "{service}", + "item": [ + { + "name": "roles", + "item": [ + { + "name": "{name}", + "item": [ + { + "name": "grants-of", + "item": [ + { + "name": "list Service Role Grants Of", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants-of", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":service", + "roles", + ":name", + "grants-of" + ], + "variable": [ + { + "key": "database", + "value": "pRBL_r", + "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": "pRBL_r", + "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": "service", + "value": "pRBL_r", + "description": "(Required) Name of the service that contains the service role." + }, + { + "key": "name", + "value": "pRBL_r", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "List all the grants of the service role" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants-of", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":service", + "roles", + ":name", + "grants-of" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "service" + }, + { + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"created_on\": \"\",\n \"role\": \"\",\n \"granted_to\": \"\",\n \"grantee_name\": \"\",\n \"granted_by\": \"\"\n },\n {\n \"created_on\": \"\",\n \"role\": \"\",\n \"granted_to\": \"\",\n \"grantee_name\": \"\",\n \"granted_by\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants-of", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":service", + "roles", + ":name", + "grants-of" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "service" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants-of", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":service", + "roles", + ":name", + "grants-of" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "service" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants-of", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":service", + "roles", + ":name", + "grants-of" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "service" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants-of", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":service", + "roles", + ":name", + "grants-of" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "service" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants-of", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":service", + "roles", + ":name", + "grants-of" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "service" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants-of", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":service", + "roles", + ":name", + "grants-of" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "service" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants-of", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":service", + "roles", + ":name", + "grants-of" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "service" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants-of", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":service", + "roles", + ":name", + "grants-of" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "service" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants-of", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":service", + "roles", + ":name", + "grants-of" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "service" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants-of", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":service", + "roles", + ":name", + "grants-of" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "service" + }, + { + "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": "grants", + "item": [ + { + "name": "list Service Role Grants To", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":service", + "roles", + ":name", + "grants" + ], + "variable": [ + { + "key": "database", + "value": "pRBL_r", + "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": "pRBL_r", + "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": "service", + "value": "pRBL_r", + "description": "(Required) Name of the service that contains the service role." + }, + { + "key": "name", + "value": "pRBL_r", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "List all the grants given to the service role" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":service", + "roles", + ":name", + "grants" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "service" + }, + { + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"created_on\": \"\",\n \"privilege\": \"\",\n \"granted_on\": \"\",\n \"name\": \"\",\n \"granted_to\": \"\",\n \"grantee_name\": \"\"\n },\n {\n \"created_on\": \"\",\n \"privilege\": \"\",\n \"granted_on\": \"\",\n \"name\": \"\",\n \"granted_to\": \"\",\n \"grantee_name\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":service", + "roles", + ":name", + "grants" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "service" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":service", + "roles", + ":name", + "grants" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "service" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":service", + "roles", + ":name", + "grants" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "service" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":service", + "roles", + ":name", + "grants" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "service" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":service", + "roles", + ":name", + "grants" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "service" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":service", + "roles", + ":name", + "grants" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "service" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":service", + "roles", + ":name", + "grants" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "service" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":service", + "roles", + ":name", + "grants" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "service" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":service", + "roles", + ":name", + "grants" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "service" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services/:service/roles/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services", + ":service", + "roles", + ":name", + "grants" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "service" + }, + { + "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": "pRBL_r", + "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": "pRBL_r", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "pRBL_r", + "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": "pRBL_r", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "pRBL_r", + "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": "pRBL_r", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"\\\"u\\\"\\\" \\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"v/\\\"\\\"VC6\\\"\\\"\\\"\",\n \"comment\": \"\",\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"database_name\": \"UlUDDNpGynD\",\n \"schema_name\": \"Jfm\"\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": "pRBL_r", + "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": "pRBL_r", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"u\\\"\\\" \\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"v/\\\"\\\"VC6\\\"\\\"\\\"\",\n \"comment\": \"\",\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"database_name\": \"UlUDDNpGynD\",\n \"schema_name\": \"Jfm\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"u\\\"\\\" \\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"v/\\\"\\\"VC6\\\"\\\"\\\"\",\n \"comment\": \"\",\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"database_name\": \"UlUDDNpGynD\",\n \"schema_name\": \"Jfm\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"u\\\"\\\" \\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"v/\\\"\\\"VC6\\\"\\\"\\\"\",\n \"comment\": \"\",\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"database_name\": \"UlUDDNpGynD\",\n \"schema_name\": \"Jfm\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"u\\\"\\\" \\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"v/\\\"\\\"VC6\\\"\\\"\\\"\",\n \"comment\": \"\",\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"database_name\": \"UlUDDNpGynD\",\n \"schema_name\": \"Jfm\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"u\\\"\\\" \\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"v/\\\"\\\"VC6\\\"\\\"\\\"\",\n \"comment\": \"\",\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"database_name\": \"UlUDDNpGynD\",\n \"schema_name\": \"Jfm\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"u\\\"\\\" \\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"v/\\\"\\\"VC6\\\"\\\"\\\"\",\n \"comment\": \"\",\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"database_name\": \"UlUDDNpGynD\",\n \"schema_name\": \"Jfm\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"u\\\"\\\" \\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"v/\\\"\\\"VC6\\\"\\\"\\\"\",\n \"comment\": \"\",\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"database_name\": \"UlUDDNpGynD\",\n \"schema_name\": \"Jfm\"\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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"u\\\"\\\" \\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"v/\\\"\\\"VC6\\\"\\\"\\\"\",\n \"comment\": \"\",\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"database_name\": \"UlUDDNpGynD\",\n \"schema_name\": \"Jfm\"\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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"u\\\"\\\" \\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"v/\\\"\\\"VC6\\\"\\\"\\\"\",\n \"comment\": \"\",\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"database_name\": \"UlUDDNpGynD\",\n \"schema_name\": \"Jfm\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"u\\\"\\\" \\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"v/\\\"\\\"VC6\\\"\\\"\\\"\",\n \"comment\": \"\",\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"database_name\": \"UlUDDNpGynD\",\n \"schema_name\": \"Jfm\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"u\\\"\\\" \\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"v/\\\"\\\"VC6\\\"\\\"\\\"\",\n \"comment\": \"\",\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"database_name\": \"UlUDDNpGynD\",\n \"schema_name\": \"Jfm\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"u\\\"\\\" \\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"v/\\\"\\\"VC6\\\"\\\"\\\"\",\n \"comment\": \"\",\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"database_name\": \"UlUDDNpGynD\",\n \"schema_name\": \"Jfm\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"u\\\"\\\" \\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"v/\\\"\\\"VC6\\\"\\\"\\\"\",\n \"comment\": \"\",\n \"auto_resume\": \"\",\n \"min_instances\": \"\",\n \"max_instances\": \"\",\n \"database_name\": \"UlUDDNpGynD\",\n \"schema_name\": \"Jfm\"\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}" + } + ] + } + ] + }, + { + "name": "services:execute-job", + "item": [ + { + "name": "Execute a job service", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"!\\\"\\\"D\\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"gIWh\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services:execute-job", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services:execute-job" + ], + "variable": [ + { + "key": "database", + "value": "pRBL_r", + "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": "pRBL_r", + "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 and execute a job service. See the JobService component definition for what is required to be provided in the request body." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"!\\\"\\\"D\\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"gIWh\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services:execute-job", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services:execute-job" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"!\\\"\\\"D\\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"gIWh\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services:execute-job", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services:execute-job" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"!\\\"\\\"D\\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"gIWh\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services:execute-job", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services:execute-job" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"!\\\"\\\"D\\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"gIWh\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services:execute-job", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services:execute-job" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"!\\\"\\\"D\\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"gIWh\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services:execute-job", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services:execute-job" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"!\\\"\\\"D\\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"gIWh\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services:execute-job", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services:execute-job" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"!\\\"\\\"D\\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"gIWh\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services:execute-job", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services:execute-job" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"!\\\"\\\"D\\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"gIWh\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services:execute-job", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services:execute-job" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"!\\\"\\\"D\\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"gIWh\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services:execute-job", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services:execute-job" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"!\\\"\\\"D\\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"gIWh\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services:execute-job", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services:execute-job" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"!\\\"\\\"D\\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"gIWh\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services:execute-job", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services:execute-job" + ], + "variable": [ + { + "key": "database" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"!\\\"\\\"D\\\"\",\n \"compute_pool\": \"\",\n \"spec\": {\n \"spec_type\": \"\"\n },\n \"status\": \"\",\n \"external_access_integrations\": [\n \"\",\n \"\"\n ],\n \"query_warehouse\": \"gIWh\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/services:execute-job", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "services:execute-job" + ], + "variable": [ + { + "key": "database" + }, + { + "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}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + }, + { + "key": "name", + "value": "pRBL_r" + } + ] +} \ No newline at end of file diff --git a/releases/8.40/collections/Snowflake Stage API.postman_collection.json b/releases/8.40/collections/Snowflake Stage API.postman_collection.json new file mode 100644 index 0000000..83230f4 --- /dev/null +++ b/releases/8.40/collections/Snowflake Stage API.postman_collection.json @@ -0,0 +1,5499 @@ +{ + "info": { + "_postman_id": "67d21639-da3f-4538-a1df-3a385ea4f77f", + "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" + }, + "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": "aomk$Dz", + "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": "aomk$Dz", + "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": "aomk$Dz", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}" + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "aomk$Dz", + "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": "aomk$Dz", + "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": "aomk$Dz", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "aomk$Dz", + "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": "aomk$Dz", + "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": "aomk$Dz", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"name\": \"\\\"\\\"\\\"1\\\\!h=K\\\"\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"\\\"\\\"\\\"\\\"\",\n \"comment\": \"\",\n \"credentials\": {\n \"credential_type\": \"\"\n },\n \"directory_table\": {\n \"enable\": false\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "aomk$Dz", + "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": "aomk$Dz", + "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": "aomk$Dz", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "aomk$Dz", + "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": "aomk$Dz", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"py7sZsh\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"vqwM569N\",\n \"comment\": \"\",\n \"credentials\": {\n \"credential_type\": \"\"\n },\n \"directory_table\": {\n \"enable\": false\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\": \"\\\"\\\"\\\"(\\\"\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"\\\"\\\"\\\"8_\\\"\\\"\\\"\",\n \"comment\": \"\",\n \"credentials\": {\n \"credential_type\": \"\"\n },\n \"directory_table\": {\n \"enable\": false\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"L1\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"O3FJTbv\",\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}", + "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": "aomk$Dz", + "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": "aomk$Dz", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"L1\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"O3FJTbv\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"L1\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"O3FJTbv\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"L1\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"O3FJTbv\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"L1\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"O3FJTbv\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"L1\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"O3FJTbv\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"L1\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"O3FJTbv\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"L1\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"O3FJTbv\",\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}", + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"L1\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"O3FJTbv\",\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}", + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"L1\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"O3FJTbv\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"L1\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"O3FJTbv\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"L1\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"O3FJTbv\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"L1\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"O3FJTbv\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"L1\",\n \"kind\": \"PERMANENT\",\n \"url\": \"\",\n \"endpoint\": \"\",\n \"storage_integration\": \"O3FJTbv\",\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}", + "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}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + }, + { + "key": "filePath", + "value": "" + } + ] +} \ No newline at end of file diff --git a/releases/8.40/collections/Snowflake Stream API.postman_collection.json b/releases/8.40/collections/Snowflake Stream API.postman_collection.json new file mode 100644 index 0000000..b4113c1 --- /dev/null +++ b/releases/8.40/collections/Snowflake Stream API.postman_collection.json @@ -0,0 +1,5600 @@ +{ + "info": { + "_postman_id": "4151ef33-54d2-4b7c-b10c-29c92b130d93", + "name": "Snowflake Stream API", + "description": "The Snowflake Stream API is a REST API that you can use to access, update, and perform certain actions on Stream 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" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "databases", + "item": [ + { + "name": "{database}", + "item": [ + { + "name": "schemas", + "item": [ + { + "name": "{schema}", + "item": [ + { + "name": "streams", + "item": [ + { + "name": "{name}", + "item": [ + { + "name": "Fetch a stream", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + ":name" + ], + "variable": [ + { + "key": "database", + "value": "m9G", + "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": "m9G", + "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": "m9G", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Fetch a stream" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + ":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\": \"OrUN36\",\n \"stream_source\": {\n \"src_type\": \"\",\n \"name\": \"r\",\n \"database_name\": \"Pm\",\n \"schema_name\": \"\\\"\\\"\\\"_ZZ\\\"\"\n },\n \"created_on\": \"\",\n \"comment\": \"\",\n \"database_name\": \"sQ09qE2RN\",\n \"schema_name\": \"TAUw\",\n \"owner\": \"\\\"o\\\"\\\"\\\"\\\"eD\\\"\",\n \"table_name\": \"\\\"x\\\"\",\n \"stale\": \"\",\n \"mode\": \"\",\n \"stale_after\": \"\",\n \"invalid_reason\": \"\",\n \"owner_role_type\": \"\\\"\\\"\\\"\\\"\\\"f\\\"\\\"\\\"\\\"\\\"\\\"[\\\"\",\n \"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/streams/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + ":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/streams/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + ":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/streams/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + ":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/streams/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + ":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/streams/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + ":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/streams/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + ":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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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/streams/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + ":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/streams/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + ":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/streams/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + ":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/streams/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + ":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/streams/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + ":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/streams/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + ":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 stream", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + ":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": "m9G", + "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": "m9G", + "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": "m9G", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Delete a stream" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + ":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/streams/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + ":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/streams/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + ":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/streams/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + ":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/streams/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + ":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/streams/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + ":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/streams/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + ":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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + ":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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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/streams/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + ":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/streams/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + ":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/streams/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + ":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/streams/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + ":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/streams/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + ":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/streams/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + ":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 a stream", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"YN\\\"\\\"B\\\"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams/{{name}}:clone?createMode=errorIfExists&targetDatabase=\"\"\"\"&targetSchema=\"\"\"\"©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + "{{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": "targetDatabase", + "value": "\"\"\"\"", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "\"\"\"\"", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + } + ], + "variable": [ + { + "key": "database", + "value": "m9G", + "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": "m9G", + "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": "Clone a stream" + }, + "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\": \"\\\"YN\\\"\\\"B\\\"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams/{{name}}:clone?createMode=errorIfExists&targetDatabase=\"\"\"\"&targetSchema=\"\"\"\"©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + "{{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": "targetDatabase", + "value": "\"\"\"\"", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "\"\"\"\"", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "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\": \"\\\"YN\\\"\\\"B\\\"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams/{{name}}:clone?createMode=errorIfExists&targetDatabase=\"\"\"\"&targetSchema=\"\"\"\"©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + "{{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": "targetDatabase", + "value": "\"\"\"\"", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "\"\"\"\"", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "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\": \"\\\"YN\\\"\\\"B\\\"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams/{{name}}:clone?createMode=errorIfExists&targetDatabase=\"\"\"\"&targetSchema=\"\"\"\"©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + "{{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": "targetDatabase", + "value": "\"\"\"\"", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "\"\"\"\"", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "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\": \"\\\"YN\\\"\\\"B\\\"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams/{{name}}:clone?createMode=errorIfExists&targetDatabase=\"\"\"\"&targetSchema=\"\"\"\"©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + "{{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": "targetDatabase", + "value": "\"\"\"\"", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "\"\"\"\"", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "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\": \"\\\"YN\\\"\\\"B\\\"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams/{{name}}:clone?createMode=errorIfExists&targetDatabase=\"\"\"\"&targetSchema=\"\"\"\"©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + "{{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": "targetDatabase", + "value": "\"\"\"\"", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "\"\"\"\"", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "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\": \"\\\"YN\\\"\\\"B\\\"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams/{{name}}:clone?createMode=errorIfExists&targetDatabase=\"\"\"\"&targetSchema=\"\"\"\"©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + "{{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": "targetDatabase", + "value": "\"\"\"\"", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "\"\"\"\"", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "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\": \"\\\"YN\\\"\\\"B\\\"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams/{{name}}:clone?createMode=errorIfExists&targetDatabase=\"\"\"\"&targetSchema=\"\"\"\"©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + "{{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": "targetDatabase", + "value": "\"\"\"\"", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "\"\"\"\"", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"YN\\\"\\\"B\\\"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams/{{name}}:clone?createMode=errorIfExists&targetDatabase=\"\"\"\"&targetSchema=\"\"\"\"©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + "{{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": "targetDatabase", + "value": "\"\"\"\"", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "\"\"\"\"", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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\": \"\\\"YN\\\"\\\"B\\\"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams/{{name}}:clone?createMode=errorIfExists&targetDatabase=\"\"\"\"&targetSchema=\"\"\"\"©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + "{{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": "targetDatabase", + "value": "\"\"\"\"", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "\"\"\"\"", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "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\": \"\\\"YN\\\"\\\"B\\\"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams/{{name}}:clone?createMode=errorIfExists&targetDatabase=\"\"\"\"&targetSchema=\"\"\"\"©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + "{{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": "targetDatabase", + "value": "\"\"\"\"", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "\"\"\"\"", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "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\": \"\\\"YN\\\"\\\"B\\\"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams/{{name}}:clone?createMode=errorIfExists&targetDatabase=\"\"\"\"&targetSchema=\"\"\"\"©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + "{{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": "targetDatabase", + "value": "\"\"\"\"", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "\"\"\"\"", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "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\": \"\\\"YN\\\"\\\"B\\\"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams/{{name}}:clone?createMode=errorIfExists&targetDatabase=\"\"\"\"&targetSchema=\"\"\"\"©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + "{{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": "targetDatabase", + "value": "\"\"\"\"", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "\"\"\"\"", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "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\": \"\\\"YN\\\"\\\"B\\\"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams/{{name}}:clone?createMode=errorIfExists&targetDatabase=\"\"\"\"&targetSchema=\"\"\"\"©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + "{{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": "targetDatabase", + "value": "\"\"\"\"", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "\"\"\"\"", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "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\": \"\\\"YN\\\"\\\"B\\\"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams/{{name}}:clone?createMode=errorIfExists&targetDatabase=\"\"\"\"&targetSchema=\"\"\"\"©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams", + "{{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": "targetDatabase", + "value": "\"\"\"\"", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "\"\"\"\"", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "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": "List streams", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams" + ], + "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": "m9G", + "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": "m9G", + "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": "List streams" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams" + ], + "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\": \"\\\"N\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"m I\\\"\",\n \"stream_source\": {\n \"src_type\": \"\",\n \"name\": \"\\\"#\\\"\\\"%x+J\\\"\\\"G\\\"\\\"\\\"\\\"k\\\"\",\n \"database_name\": \"eACWhMs\",\n \"schema_name\": \"JMxv0It\"\n },\n \"created_on\": \"\",\n \"comment\": \"\",\n \"database_name\": \"\\\"2\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"S\\\"\",\n \"schema_name\": \"\\\"e\\\"\\\"p\\\"\\\"\\\"\\\"B\\\"\",\n \"owner\": \"\\\"L**J~K\\\"\\\"j\\\"\",\n \"table_name\": \"\\\"\\\"\\\"\\\"\\\".h)\\\"\\\"s\\\"\",\n \"stale\": \"\",\n \"mode\": \"\",\n \"stale_after\": \"\",\n \"invalid_reason\": \"\",\n \"owner_role_type\": \"\\\"j\\\"\\\"V}\\\"\",\n \"type\": \"\"\n },\n {\n \"name\": \"D4mzer8cx\",\n \"stream_source\": {\n \"src_type\": \"\",\n \"name\": \"o\",\n \"database_name\": \"\\\"H\\\"\\\"T)\\\"\\\"`\\\"\\\"\\\"\\\"2\\\"\",\n \"schema_name\": \"TXNRCSSdqI2\"\n },\n \"created_on\": \"\",\n \"comment\": \"\",\n \"database_name\": \"v0\",\n \"schema_name\": \"x\",\n \"owner\": \"hH\",\n \"table_name\": \"\\\"3\\\"\\\"S\\\"\\\"i\\\"\",\n \"stale\": \"\",\n \"mode\": \"\",\n \"stale_after\": \"\",\n \"invalid_reason\": \"\",\n \"owner_role_type\": \"n3o24Ak\",\n \"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/streams?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams" + ], + "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/streams?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams" + ], + "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/streams?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams" + ], + "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/streams?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams" + ], + "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/streams?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams" + ], + "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/streams?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams" + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams" + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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/streams?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams" + ], + "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": "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/streams?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams" + ], + "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": "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/streams?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams" + ], + "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/streams?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams" + ], + "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/streams?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams" + ], + "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/streams?like=&startsWith=&showLimit=&fromName=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams" + ], + "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 stream", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\",\n \"stream_source\": {\n \"src_type\": \"\",\n \"name\": \"\\\"\\\"\\\"\\\"\\\"}\\\"\",\n \"database_name\": \"Hvd38\",\n \"schema_name\": \"\\\"Q}\\\"\\\"\\\"\"\n },\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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": "m9G", + "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": "m9G", + "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 stream" + }, + "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 \"stream_source\": {\n \"src_type\": \"\",\n \"name\": \"\\\"\\\"\\\"\\\"\\\"}\\\"\",\n \"database_name\": \"Hvd38\",\n \"schema_name\": \"\\\"Q}\\\"\\\"\\\"\"\n },\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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 \"stream_source\": {\n \"src_type\": \"\",\n \"name\": \"\\\"\\\"\\\"\\\"\\\"}\\\"\",\n \"database_name\": \"Hvd38\",\n \"schema_name\": \"\\\"Q}\\\"\\\"\\\"\"\n },\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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 \"stream_source\": {\n \"src_type\": \"\",\n \"name\": \"\\\"\\\"\\\"\\\"\\\"}\\\"\",\n \"database_name\": \"Hvd38\",\n \"schema_name\": \"\\\"Q}\\\"\\\"\\\"\"\n },\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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 \"stream_source\": {\n \"src_type\": \"\",\n \"name\": \"\\\"\\\"\\\"\\\"\\\"}\\\"\",\n \"database_name\": \"Hvd38\",\n \"schema_name\": \"\\\"Q}\\\"\\\"\\\"\"\n },\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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 \"stream_source\": {\n \"src_type\": \"\",\n \"name\": \"\\\"\\\"\\\"\\\"\\\"}\\\"\",\n \"database_name\": \"Hvd38\",\n \"schema_name\": \"\\\"Q}\\\"\\\"\\\"\"\n },\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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 \"stream_source\": {\n \"src_type\": \"\",\n \"name\": \"\\\"\\\"\\\"\\\"\\\"}\\\"\",\n \"database_name\": \"Hvd38\",\n \"schema_name\": \"\\\"Q}\\\"\\\"\\\"\"\n },\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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 \"stream_source\": {\n \"src_type\": \"\",\n \"name\": \"\\\"\\\"\\\"\\\"\\\"}\\\"\",\n \"database_name\": \"Hvd38\",\n \"schema_name\": \"\\\"Q}\\\"\\\"\\\"\"\n },\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"#\\\"\",\n \"stream_source\": {\n \"src_type\": \"\",\n \"name\": \"\\\"\\\"\\\"\\\"\\\"}\\\"\",\n \"database_name\": \"Hvd38\",\n \"schema_name\": \"\\\"Q}\\\"\\\"\\\"\"\n },\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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 \"stream_source\": {\n \"src_type\": \"\",\n \"name\": \"\\\"\\\"\\\"\\\"\\\"}\\\"\",\n \"database_name\": \"Hvd38\",\n \"schema_name\": \"\\\"Q}\\\"\\\"\\\"\"\n },\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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 \"stream_source\": {\n \"src_type\": \"\",\n \"name\": \"\\\"\\\"\\\"\\\"\\\"}\\\"\",\n \"database_name\": \"Hvd38\",\n \"schema_name\": \"\\\"Q}\\\"\\\"\\\"\"\n },\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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 \"stream_source\": {\n \"src_type\": \"\",\n \"name\": \"\\\"\\\"\\\"\\\"\\\"}\\\"\",\n \"database_name\": \"Hvd38\",\n \"schema_name\": \"\\\"Q}\\\"\\\"\\\"\"\n },\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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 \"stream_source\": {\n \"src_type\": \"\",\n \"name\": \"\\\"\\\"\\\"\\\"\\\"}\\\"\",\n \"database_name\": \"Hvd38\",\n \"schema_name\": \"\\\"Q}\\\"\\\"\\\"\"\n },\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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 \"stream_source\": {\n \"src_type\": \"\",\n \"name\": \"\\\"\\\"\\\"\\\"\\\"}\\\"\",\n \"database_name\": \"Hvd38\",\n \"schema_name\": \"\\\"Q}\\\"\\\"\\\"\"\n },\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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 \"stream_source\": {\n \"src_type\": \"\",\n \"name\": \"\\\"\\\"\\\"\\\"\\\"}\\\"\",\n \"database_name\": \"Hvd38\",\n \"schema_name\": \"\\\"Q}\\\"\\\"\\\"\"\n },\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/streams?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "streams" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + }, + { + "key": "name", + "value": "m9G" + } + ] +} \ No newline at end of file diff --git a/releases/8.40/collections/Snowflake Table API.postman_collection.json b/releases/8.40/collections/Snowflake Table API.postman_collection.json new file mode 100644 index 0000000..33f262c --- /dev/null +++ b/releases/8.40/collections/Snowflake Table API.postman_collection.json @@ -0,0 +1,22117 @@ +{ + "info": { + "_postman_id": "7fb62b78-e71f-4382-bf94-7f91200947ee", + "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" + }, + "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}", + "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": "Owhb", + "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": "Owhb", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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": "Owhb", + "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": "Owhb", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Owhb", + "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": "Owhb", + "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": "Owhb", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "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 \"table_type\": \"EXTERNAL\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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": "Owhb", + "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": "Owhb", + "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": "Owhb", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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": "Owhb", + "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": "Owhb", + "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": "Owhb", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"ipsum\",\n \"reference\": \"nisi reprehenderit\"\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}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=Owhb&targetSchema=Owhb", + "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": "Owhb", + "description": "Database of the newly created table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "Owhb", + "description": "Schema of the newly created table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database", + "value": "Owhb", + "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": "Owhb", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"ipsum\",\n \"reference\": \"nisi reprehenderit\"\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}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=Owhb&targetSchema=Owhb", + "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": "Owhb", + "description": "Database of the newly created table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "Owhb", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"ipsum\",\n \"reference\": \"nisi reprehenderit\"\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}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=Owhb&targetSchema=Owhb", + "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": "Owhb", + "description": "Database of the newly created table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "Owhb", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"ipsum\",\n \"reference\": \"nisi reprehenderit\"\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}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=Owhb&targetSchema=Owhb", + "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": "Owhb", + "description": "Database of the newly created table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "Owhb", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"ipsum\",\n \"reference\": \"nisi reprehenderit\"\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}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=Owhb&targetSchema=Owhb", + "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": "Owhb", + "description": "Database of the newly created table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "Owhb", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"ipsum\",\n \"reference\": \"nisi reprehenderit\"\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}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=Owhb&targetSchema=Owhb", + "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": "Owhb", + "description": "Database of the newly created table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "Owhb", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"ipsum\",\n \"reference\": \"nisi reprehenderit\"\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}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=Owhb&targetSchema=Owhb", + "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": "Owhb", + "description": "Database of the newly created table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "Owhb", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"ipsum\",\n \"reference\": \"nisi reprehenderit\"\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}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=Owhb&targetSchema=Owhb", + "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": "Owhb", + "description": "Database of the newly created table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "Owhb", + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"ipsum\",\n \"reference\": \"nisi reprehenderit\"\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}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=Owhb&targetSchema=Owhb", + "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": "Owhb", + "description": "Database of the newly created table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "Owhb", + "description": "Schema of the newly created table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"ipsum\",\n \"reference\": \"nisi reprehenderit\"\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}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=Owhb&targetSchema=Owhb", + "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": "Owhb", + "description": "Database of the newly created table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "Owhb", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"ipsum\",\n \"reference\": \"nisi reprehenderit\"\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}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=Owhb&targetSchema=Owhb", + "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": "Owhb", + "description": "Database of the newly created table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "Owhb", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"ipsum\",\n \"reference\": \"nisi reprehenderit\"\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}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=Owhb&targetSchema=Owhb", + "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": "Owhb", + "description": "Database of the newly created table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "Owhb", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"ipsum\",\n \"reference\": \"nisi reprehenderit\"\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}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=Owhb&targetSchema=Owhb", + "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": "Owhb", + "description": "Database of the newly created table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "Owhb", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"ipsum\",\n \"reference\": \"nisi reprehenderit\"\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}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=Owhb&targetSchema=Owhb", + "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": "Owhb", + "description": "Database of the newly created table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "Owhb", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"point_of_time\": {\n \"point_of_time_type\": \"ipsum\",\n \"reference\": \"nisi reprehenderit\"\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}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:clone?createMode=errorIfExists©Grants=false&targetDatabase=Owhb&targetSchema=Owhb", + "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": "Owhb", + "description": "Database of the newly created table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "Owhb", + "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": "Owhb", + "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": "Owhb", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Owhb", + "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": "Owhb", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Owhb", + "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": "Owhb", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Owhb", + "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": "Owhb", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Owhb", + "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": "Owhb", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Owhb", + "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": "Owhb", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Owhb", + "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": "Owhb", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Owhb", + "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": "Owhb", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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=Owhb&targetDatabase=Owhb&targetSchema=Owhb", + "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": "Owhb", + "description": "(Required) The name of the target table to be swapped with." + }, + { + "key": "targetDatabase", + "value": "Owhb", + "description": "Database of the target table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "Owhb", + "description": "Schema of the target table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database", + "value": "Owhb", + "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": "Owhb", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swap-with?ifExists=false&targetName=Owhb&targetDatabase=Owhb&targetSchema=Owhb", + "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": "Owhb", + "description": "(Required) The name of the target table to be swapped with." + }, + { + "key": "targetDatabase", + "value": "Owhb", + "description": "Database of the target table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "Owhb", + "description": "Schema of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swap-with?ifExists=false&targetName=Owhb&targetDatabase=Owhb&targetSchema=Owhb", + "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": "Owhb", + "description": "(Required) The name of the target table to be swapped with." + }, + { + "key": "targetDatabase", + "value": "Owhb", + "description": "Database of the target table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "Owhb", + "description": "Schema of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swap-with?ifExists=false&targetName=Owhb&targetDatabase=Owhb&targetSchema=Owhb", + "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": "Owhb", + "description": "(Required) The name of the target table to be swapped with." + }, + { + "key": "targetDatabase", + "value": "Owhb", + "description": "Database of the target table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "Owhb", + "description": "Schema of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swap-with?ifExists=false&targetName=Owhb&targetDatabase=Owhb&targetSchema=Owhb", + "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": "Owhb", + "description": "(Required) The name of the target table to be swapped with." + }, + { + "key": "targetDatabase", + "value": "Owhb", + "description": "Database of the target table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "Owhb", + "description": "Schema of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swap-with?ifExists=false&targetName=Owhb&targetDatabase=Owhb&targetSchema=Owhb", + "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": "Owhb", + "description": "(Required) The name of the target table to be swapped with." + }, + { + "key": "targetDatabase", + "value": "Owhb", + "description": "Database of the target table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "Owhb", + "description": "Schema of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swap-with?ifExists=false&targetName=Owhb&targetDatabase=Owhb&targetSchema=Owhb", + "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": "Owhb", + "description": "(Required) The name of the target table to be swapped with." + }, + { + "key": "targetDatabase", + "value": "Owhb", + "description": "Database of the target table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "Owhb", + "description": "Schema of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swap-with?ifExists=false&targetName=Owhb&targetDatabase=Owhb&targetSchema=Owhb", + "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": "Owhb", + "description": "(Required) The name of the target table to be swapped with." + }, + { + "key": "targetDatabase", + "value": "Owhb", + "description": "Database of the target table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "Owhb", + "description": "Schema of the target 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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swap-with?ifExists=false&targetName=Owhb&targetDatabase=Owhb&targetSchema=Owhb", + "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": "Owhb", + "description": "(Required) The name of the target table to be swapped with." + }, + { + "key": "targetDatabase", + "value": "Owhb", + "description": "Database of the target table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "Owhb", + "description": "Schema of the target table. Defaults to the source table's schema." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swap-with?ifExists=false&targetName=Owhb&targetDatabase=Owhb&targetSchema=Owhb", + "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": "Owhb", + "description": "(Required) The name of the target table to be swapped with." + }, + { + "key": "targetDatabase", + "value": "Owhb", + "description": "Database of the target table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "Owhb", + "description": "Schema of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swap-with?ifExists=false&targetName=Owhb&targetDatabase=Owhb&targetSchema=Owhb", + "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": "Owhb", + "description": "(Required) The name of the target table to be swapped with." + }, + { + "key": "targetDatabase", + "value": "Owhb", + "description": "Database of the target table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "Owhb", + "description": "Schema of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swap-with?ifExists=false&targetName=Owhb&targetDatabase=Owhb&targetSchema=Owhb", + "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": "Owhb", + "description": "(Required) The name of the target table to be swapped with." + }, + { + "key": "targetDatabase", + "value": "Owhb", + "description": "Database of the target table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "Owhb", + "description": "Schema of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swap-with?ifExists=false&targetName=Owhb&targetDatabase=Owhb&targetSchema=Owhb", + "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": "Owhb", + "description": "(Required) The name of the target table to be swapped with." + }, + { + "key": "targetDatabase", + "value": "Owhb", + "description": "Database of the target table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "Owhb", + "description": "Schema of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swap-with?ifExists=false&targetName=Owhb&targetDatabase=Owhb&targetSchema=Owhb", + "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": "Owhb", + "description": "(Required) The name of the target table to be swapped with." + }, + { + "key": "targetDatabase", + "value": "Owhb", + "description": "Database of the target table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "Owhb", + "description": "Schema of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tables/{{name}}:swap-with?ifExists=false&targetName=Owhb&targetDatabase=Owhb&targetSchema=Owhb", + "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": "Owhb", + "description": "(Required) The name of the target table to be swapped with." + }, + { + "key": "targetDatabase", + "value": "Owhb", + "description": "Database of the target table. Defaults to the source table's database." + }, + { + "key": "targetSchema", + "value": "Owhb", + "description": "Schema of the target 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": "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": "Owhb", + "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": "Owhb", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "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 \"table_type\": \"EXTERNAL\"\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 \"table_type\": \"IMMUTABLE\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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": "Owhb", + "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": "Owhb", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}", + "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": "Owhb", + "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": "Owhb", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Owhb", + "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": "Owhb", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + }, + { + "key": "name", + "value": "Owhb" + } + ] +} \ No newline at end of file diff --git a/releases/8.40/collections/Snowflake Task API.postman_collection.json b/releases/8.40/collections/Snowflake Task API.postman_collection.json new file mode 100644 index 0000000..9dfaad0 --- /dev/null +++ b/releases/8.40/collections/Snowflake Task API.postman_collection.json @@ -0,0 +1,11570 @@ +{ + "info": { + "_postman_id": "9dafde29-f942-410e-b120-c2ad438a590c", + "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" + }, + "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": "li_iT1", + "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": "li_iT1", + "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": "li_iT1", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"\\\"y$q\\\"\\\"\\\"\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"O=\\\"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"ullamcob13\": \"dolore minim culpa veniam\",\n \"exercitation_7\": \"tempor commodo\",\n \"eae7e\": -69886655\n },\n \"session_parameters\": {\n \"Ut33\": -20805619,\n \"ipsuma96\": -62030613\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\": \"BD4BGd0Hw\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"\\\"\\\"\\\"\\\"b\\\"\\\"\\\"\\\"sH]\\\"\\\"d\\\"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"dolor0c\": \"incididunt ea laboris\"\n },\n \"session_parameters\": {\n \"mollit1b8\": 64509172,\n \"minim_7\": false,\n \"anim_d55\": 85598989.60417068\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\": \"started\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "li_iT1", + "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": "li_iT1", + "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": "li_iT1", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"root_task_name\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"state\": \"CANCELLED\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "li_iT1", + "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": "li_iT1", + "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": "li_iT1", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"root_task_name\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"state\": \"CANCELLED\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "li_iT1", + "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": "li_iT1", + "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": "li_iT1", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"root_task_name\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"state\": \"CANCELLED\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "li_iT1", + "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": "li_iT1", + "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": "li_iT1", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"root_task_name\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"state\": \"CANCELLED\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "li_iT1", + "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": "li_iT1", + "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": "li_iT1", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"name\": \"gk4nfc0dnI\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"officia3\": -47677278,\n \"aliqua_d5a\": true\n },\n \"session_parameters\": {\n \"inde0\": 88286233.98424798\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\": \"started\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"U\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"\\\"\\\"\\\"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"dolore5\": true,\n \"occaecat__6\": -87947252.89140782\n },\n \"session_parameters\": {\n \"reprehenderit6\": false,\n \"pariatur_6\": 4003353.7472451627,\n \"aliquip7\": -15522775,\n \"autef8\": -26540132.703184545\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\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}", + "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": "li_iT1", + "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": "li_iT1", + "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": "li_iT1", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"U\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"\\\"\\\"\\\"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"dolore5\": true,\n \"occaecat__6\": -87947252.89140782\n },\n \"session_parameters\": {\n \"reprehenderit6\": false,\n \"pariatur_6\": 4003353.7472451627,\n \"aliquip7\": -15522775,\n \"autef8\": -26540132.703184545\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"U\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"\\\"\\\"\\\"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"dolore5\": true,\n \"occaecat__6\": -87947252.89140782\n },\n \"session_parameters\": {\n \"reprehenderit6\": false,\n \"pariatur_6\": 4003353.7472451627,\n \"aliquip7\": -15522775,\n \"autef8\": -26540132.703184545\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"U\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"\\\"\\\"\\\"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"dolore5\": true,\n \"occaecat__6\": -87947252.89140782\n },\n \"session_parameters\": {\n \"reprehenderit6\": false,\n \"pariatur_6\": 4003353.7472451627,\n \"aliquip7\": -15522775,\n \"autef8\": -26540132.703184545\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"U\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"\\\"\\\"\\\"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"dolore5\": true,\n \"occaecat__6\": -87947252.89140782\n },\n \"session_parameters\": {\n \"reprehenderit6\": false,\n \"pariatur_6\": 4003353.7472451627,\n \"aliquip7\": -15522775,\n \"autef8\": -26540132.703184545\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"U\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"\\\"\\\"\\\"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"dolore5\": true,\n \"occaecat__6\": -87947252.89140782\n },\n \"session_parameters\": {\n \"reprehenderit6\": false,\n \"pariatur_6\": 4003353.7472451627,\n \"aliquip7\": -15522775,\n \"autef8\": -26540132.703184545\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"U\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"\\\"\\\"\\\"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"dolore5\": true,\n \"occaecat__6\": -87947252.89140782\n },\n \"session_parameters\": {\n \"reprehenderit6\": false,\n \"pariatur_6\": 4003353.7472451627,\n \"aliquip7\": -15522775,\n \"autef8\": -26540132.703184545\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"U\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"\\\"\\\"\\\"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"dolore5\": true,\n \"occaecat__6\": -87947252.89140782\n },\n \"session_parameters\": {\n \"reprehenderit6\": false,\n \"pariatur_6\": 4003353.7472451627,\n \"aliquip7\": -15522775,\n \"autef8\": -26540132.703184545\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"U\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"\\\"\\\"\\\"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"dolore5\": true,\n \"occaecat__6\": -87947252.89140782\n },\n \"session_parameters\": {\n \"reprehenderit6\": false,\n \"pariatur_6\": 4003353.7472451627,\n \"aliquip7\": -15522775,\n \"autef8\": -26540132.703184545\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"U\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"\\\"\\\"\\\"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"dolore5\": true,\n \"occaecat__6\": -87947252.89140782\n },\n \"session_parameters\": {\n \"reprehenderit6\": false,\n \"pariatur_6\": 4003353.7472451627,\n \"aliquip7\": -15522775,\n \"autef8\": -26540132.703184545\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"U\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"\\\"\\\"\\\"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"dolore5\": true,\n \"occaecat__6\": -87947252.89140782\n },\n \"session_parameters\": {\n \"reprehenderit6\": false,\n \"pariatur_6\": 4003353.7472451627,\n \"aliquip7\": -15522775,\n \"autef8\": -26540132.703184545\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"U\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"\\\"\\\"\\\"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"dolore5\": true,\n \"occaecat__6\": -87947252.89140782\n },\n \"session_parameters\": {\n \"reprehenderit6\": false,\n \"pariatur_6\": 4003353.7472451627,\n \"aliquip7\": -15522775,\n \"autef8\": -26540132.703184545\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\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}", + "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": "li_iT1", + "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": "li_iT1", + "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": "li_iT1", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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?asyncExec=false&retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "asyncExec", + "value": "false", + "description": "Asynchronous execution enable/disable. Default is disable." + }, + { + "key": "retryLast", + "value": "false", + "description": "Retry the last failed run of the DAG." + } + ], + "variable": [ + { + "key": "database", + "value": "li_iT1", + "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": "li_iT1", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?asyncExec=false&retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "asyncExec", + "value": "false", + "description": "Asynchronous execution enable/disable. Default is disable." + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?asyncExec=false&retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "asyncExec", + "value": "false", + "description": "Asynchronous execution enable/disable. Default is disable." + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?asyncExec=false&retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "asyncExec", + "value": "false", + "description": "Asynchronous execution enable/disable. Default is disable." + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?asyncExec=false&retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "asyncExec", + "value": "false", + "description": "Asynchronous execution enable/disable. Default is disable." + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?asyncExec=false&retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "asyncExec", + "value": "false", + "description": "Asynchronous execution enable/disable. Default is disable." + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?asyncExec=false&retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "asyncExec", + "value": "false", + "description": "Asynchronous execution enable/disable. Default is disable." + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?asyncExec=false&retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "asyncExec", + "value": "false", + "description": "Asynchronous execution enable/disable. Default is disable." + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?asyncExec=false&retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "asyncExec", + "value": "false", + "description": "Asynchronous execution enable/disable. Default is disable." + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?asyncExec=false&retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "asyncExec", + "value": "false", + "description": "Asynchronous execution enable/disable. Default is disable." + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?asyncExec=false&retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "asyncExec", + "value": "false", + "description": "Asynchronous execution enable/disable. Default is disable." + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?asyncExec=false&retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "asyncExec", + "value": "false", + "description": "Asynchronous execution enable/disable. Default is disable." + }, + { + "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": "li_iT1", + "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": "li_iT1", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "li_iT1", + "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": "li_iT1", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "li_iT1", + "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": "li_iT1", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"\\\"y$q\\\"\\\"\\\"\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"O=\\\"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"ullamcob13\": \"dolore minim culpa veniam\",\n \"exercitation_7\": \"tempor commodo\",\n \"eae7e\": -69886655\n },\n \"session_parameters\": {\n \"Ut33\": -20805619,\n \"ipsuma96\": -62030613\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\": \"BD4BGd0Hw\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"\\\"\\\"\\\"\\\"b\\\"\\\"\\\"\\\"sH]\\\"\\\"d\\\"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"dolor0c\": \"incididunt ea laboris\"\n },\n \"session_parameters\": {\n \"mollit1b8\": 64509172,\n \"minim_7\": false,\n \"anim_d55\": 85598989.60417068\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\": \"started\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"U\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"\\\"\\\"\\\"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"dolore5\": true,\n \"occaecat__6\": -87947252.89140782\n },\n \"session_parameters\": {\n \"reprehenderit6\": false,\n \"pariatur_6\": 4003353.7472451627,\n \"aliquip7\": -15522775,\n \"autef8\": -26540132.703184545\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\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}", + "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": "li_iT1", + "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": "li_iT1", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"U\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"\\\"\\\"\\\"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"dolore5\": true,\n \"occaecat__6\": -87947252.89140782\n },\n \"session_parameters\": {\n \"reprehenderit6\": false,\n \"pariatur_6\": 4003353.7472451627,\n \"aliquip7\": -15522775,\n \"autef8\": -26540132.703184545\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"U\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"\\\"\\\"\\\"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"dolore5\": true,\n \"occaecat__6\": -87947252.89140782\n },\n \"session_parameters\": {\n \"reprehenderit6\": false,\n \"pariatur_6\": 4003353.7472451627,\n \"aliquip7\": -15522775,\n \"autef8\": -26540132.703184545\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"U\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"\\\"\\\"\\\"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"dolore5\": true,\n \"occaecat__6\": -87947252.89140782\n },\n \"session_parameters\": {\n \"reprehenderit6\": false,\n \"pariatur_6\": 4003353.7472451627,\n \"aliquip7\": -15522775,\n \"autef8\": -26540132.703184545\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"U\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"\\\"\\\"\\\"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"dolore5\": true,\n \"occaecat__6\": -87947252.89140782\n },\n \"session_parameters\": {\n \"reprehenderit6\": false,\n \"pariatur_6\": 4003353.7472451627,\n \"aliquip7\": -15522775,\n \"autef8\": -26540132.703184545\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"U\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"\\\"\\\"\\\"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"dolore5\": true,\n \"occaecat__6\": -87947252.89140782\n },\n \"session_parameters\": {\n \"reprehenderit6\": false,\n \"pariatur_6\": 4003353.7472451627,\n \"aliquip7\": -15522775,\n \"autef8\": -26540132.703184545\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"U\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"\\\"\\\"\\\"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"dolore5\": true,\n \"occaecat__6\": -87947252.89140782\n },\n \"session_parameters\": {\n \"reprehenderit6\": false,\n \"pariatur_6\": 4003353.7472451627,\n \"aliquip7\": -15522775,\n \"autef8\": -26540132.703184545\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"U\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"\\\"\\\"\\\"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"dolore5\": true,\n \"occaecat__6\": -87947252.89140782\n },\n \"session_parameters\": {\n \"reprehenderit6\": false,\n \"pariatur_6\": 4003353.7472451627,\n \"aliquip7\": -15522775,\n \"autef8\": -26540132.703184545\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\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}", + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"U\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"\\\"\\\"\\\"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"dolore5\": true,\n \"occaecat__6\": -87947252.89140782\n },\n \"session_parameters\": {\n \"reprehenderit6\": false,\n \"pariatur_6\": 4003353.7472451627,\n \"aliquip7\": -15522775,\n \"autef8\": -26540132.703184545\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\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}", + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"U\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"\\\"\\\"\\\"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"dolore5\": true,\n \"occaecat__6\": -87947252.89140782\n },\n \"session_parameters\": {\n \"reprehenderit6\": false,\n \"pariatur_6\": 4003353.7472451627,\n \"aliquip7\": -15522775,\n \"autef8\": -26540132.703184545\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"U\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"\\\"\\\"\\\"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"dolore5\": true,\n \"occaecat__6\": -87947252.89140782\n },\n \"session_parameters\": {\n \"reprehenderit6\": false,\n \"pariatur_6\": 4003353.7472451627,\n \"aliquip7\": -15522775,\n \"autef8\": -26540132.703184545\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"U\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"\\\"\\\"\\\"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"dolore5\": true,\n \"occaecat__6\": -87947252.89140782\n },\n \"session_parameters\": {\n \"reprehenderit6\": false,\n \"pariatur_6\": 4003353.7472451627,\n \"aliquip7\": -15522775,\n \"autef8\": -26540132.703184545\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"U\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"\\\"\\\"\\\"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"dolore5\": true,\n \"occaecat__6\": -87947252.89140782\n },\n \"session_parameters\": {\n \"reprehenderit6\": false,\n \"pariatur_6\": 4003353.7472451627,\n \"aliquip7\": -15522775,\n \"autef8\": -26540132.703184545\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"U\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"\\\"\\\"\\\"\",\n \"schedule\": {\n \"schedule_type\": \"\"\n },\n \"comment\": \"\",\n \"finalize\": \"\",\n \"task_auto_retry_attempts\": \"\",\n \"config\": {\n \"dolore5\": true,\n \"occaecat__6\": -87947252.89140782\n },\n \"session_parameters\": {\n \"reprehenderit6\": false,\n \"pariatur_6\": 4003353.7472451627,\n \"aliquip7\": -15522775,\n \"autef8\": -26540132.703184545\n },\n \"predecessors\": [\n \"\",\n \"\"\n ],\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}", + "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}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + }, + { + "key": "name", + "value": "li_iT1" + } + ] +} \ No newline at end of file diff --git a/releases/8.40/collections/Snowflake User API.postman_collection.json b/releases/8.40/collections/Snowflake User API.postman_collection.json new file mode 100644 index 0000000..fad53d4 --- /dev/null +++ b/releases/8.40/collections/Snowflake User API.postman_collection.json @@ -0,0 +1,7699 @@ +{ + "info": { + "_postman_id": "38bf7342-9e35-43c7-9507-d47b7efbc747", + "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" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "users", + "item": [ + { + "name": "{name}", + "item": [ + { + "name": "grants", + "item": [ + { + "name": "List all grants to the user", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "variable": [ + { + "key": "name", + "value": "RteOreH", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "List all grants to the user" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"t\",\n \"database\": \"\\\"\\\"\\\"D\\\"\\\"\\\"\",\n \"schema\": \"\\\"6\\\"\\\"\\\"\\\"P\\\"\\\"`+2\\\"\\\"*\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"h\\\"\\\"}\\\"\\\"\\\"\\\"\\\"\\\"pF\\\"\",\n \"schema\": \"wUsW\"\n },\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"created_on\": \"\",\n \"granted_by\": \"\"\n },\n {\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"p\\\"\\\"\\\"\",\n \"database\": \"S2abCiq1wt\",\n \"schema\": \"\\\"`\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"g\\\"\\\"l\\\"\\\"H\\\"\",\n \"schema\": \"Gc55utu\"\n },\n \"privileges\": [\n \"\",\n \"\"\n ],\n \"created_on\": \"\",\n \"granted_by\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants?showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants" + ], + "query": [ + { + "key": "showLimit", + "value": "", + "description": "Query parameter to limit the maximum number of rows returned by a command." + } + ], + "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": "Grant a role to the user", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"j\\\"\\\"A@\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database\": \"\\\"CR\\\"\\\"FAW\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"\\\"\\\"Bec|\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"Hv2CT\"\n },\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants" + ], + "variable": [ + { + "key": "name", + "value": "RteOreH", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Grant a role to the user" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"j\\\"\\\"A@\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database\": \"\\\"CR\\\"\\\"FAW\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"\\\"\\\"Bec|\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"Hv2CT\"\n },\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"j\\\"\\\"A@\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database\": \"\\\"CR\\\"\\\"FAW\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"\\\"\\\"Bec|\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"Hv2CT\"\n },\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"j\\\"\\\"A@\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database\": \"\\\"CR\\\"\\\"FAW\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"\\\"\\\"Bec|\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"Hv2CT\"\n },\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"j\\\"\\\"A@\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database\": \"\\\"CR\\\"\\\"FAW\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"\\\"\\\"Bec|\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"Hv2CT\"\n },\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"j\\\"\\\"A@\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database\": \"\\\"CR\\\"\\\"FAW\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"\\\"\\\"Bec|\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"Hv2CT\"\n },\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"j\\\"\\\"A@\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database\": \"\\\"CR\\\"\\\"FAW\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"\\\"\\\"Bec|\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"Hv2CT\"\n },\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"j\\\"\\\"A@\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database\": \"\\\"CR\\\"\\\"FAW\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"\\\"\\\"Bec|\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"Hv2CT\"\n },\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants" + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"j\\\"\\\"A@\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database\": \"\\\"CR\\\"\\\"FAW\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"\\\"\\\"Bec|\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"Hv2CT\"\n },\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"j\\\"\\\"A@\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database\": \"\\\"CR\\\"\\\"FAW\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"\\\"\\\"Bec|\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"Hv2CT\"\n },\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"j\\\"\\\"A@\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database\": \"\\\"CR\\\"\\\"FAW\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"\\\"\\\"Bec|\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"Hv2CT\"\n },\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"j\\\"\\\"A@\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database\": \"\\\"CR\\\"\\\"FAW\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"\\\"\\\"Bec|\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"Hv2CT\"\n },\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"j\\\"\\\"A@\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database\": \"\\\"CR\\\"\\\"FAW\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"\\\"\\\"Bec|\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"Hv2CT\"\n },\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"j\\\"\\\"A@\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database\": \"\\\"CR\\\"\\\"FAW\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"\\\"\\\"Bec|\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"Hv2CT\"\n },\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"j\\\"\\\"A@\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database\": \"\\\"CR\\\"\\\"FAW\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"\\\"\\\"Bec|\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"Hv2CT\"\n },\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants" + ], + "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": "grants:revoke", + "item": [ + { + "name": "Revoke grants from the user", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"j\\\"\\\"A@\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database\": \"\\\"CR\\\"\\\"FAW\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"\\\"\\\"Bec|\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"Hv2CT\"\n },\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants:revoke", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants:revoke" + ], + "variable": [ + { + "key": "name", + "value": "RteOreH", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Revoke grants from the user" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"j\\\"\\\"A@\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database\": \"\\\"CR\\\"\\\"FAW\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"\\\"\\\"Bec|\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"Hv2CT\"\n },\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants:revoke", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants:revoke" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"j\\\"\\\"A@\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database\": \"\\\"CR\\\"\\\"FAW\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"\\\"\\\"Bec|\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"Hv2CT\"\n },\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants:revoke", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants:revoke" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"j\\\"\\\"A@\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database\": \"\\\"CR\\\"\\\"FAW\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"\\\"\\\"Bec|\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"Hv2CT\"\n },\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants:revoke", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants:revoke" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"j\\\"\\\"A@\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database\": \"\\\"CR\\\"\\\"FAW\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"\\\"\\\"Bec|\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"Hv2CT\"\n },\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants:revoke", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants:revoke" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"j\\\"\\\"A@\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database\": \"\\\"CR\\\"\\\"FAW\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"\\\"\\\"Bec|\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"Hv2CT\"\n },\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants:revoke", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants:revoke" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"j\\\"\\\"A@\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database\": \"\\\"CR\\\"\\\"FAW\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"\\\"\\\"Bec|\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"Hv2CT\"\n },\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants:revoke", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants:revoke" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"j\\\"\\\"A@\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database\": \"\\\"CR\\\"\\\"FAW\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"\\\"\\\"Bec|\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"Hv2CT\"\n },\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants:revoke", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants:revoke" + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"j\\\"\\\"A@\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database\": \"\\\"CR\\\"\\\"FAW\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"\\\"\\\"Bec|\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"Hv2CT\"\n },\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants:revoke", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants:revoke" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"j\\\"\\\"A@\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database\": \"\\\"CR\\\"\\\"FAW\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"\\\"\\\"Bec|\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"Hv2CT\"\n },\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants:revoke", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants:revoke" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"j\\\"\\\"A@\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database\": \"\\\"CR\\\"\\\"FAW\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"\\\"\\\"Bec|\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"Hv2CT\"\n },\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants:revoke", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants:revoke" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"j\\\"\\\"A@\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database\": \"\\\"CR\\\"\\\"FAW\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"\\\"\\\"Bec|\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"Hv2CT\"\n },\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants:revoke", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants:revoke" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"j\\\"\\\"A@\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database\": \"\\\"CR\\\"\\\"FAW\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"\\\"\\\"Bec|\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"Hv2CT\"\n },\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants:revoke", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants:revoke" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"j\\\"\\\"A@\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database\": \"\\\"CR\\\"\\\"FAW\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"\\\"\\\"Bec|\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"Hv2CT\"\n },\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants:revoke", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants:revoke" + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"securable_type\": \"\",\n \"securable\": {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"j\\\"\\\"A@\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"database\": \"\\\"CR\\\"\\\"FAW\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"\\\"\\\"\\\"Bec|\\\"\"\n },\n \"containing_scope\": {\n \"database\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"schema\": \"Hv2CT\"\n },\n \"privileges\": [\n \"\",\n \"\"\n ]\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name/grants:revoke", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name", + "grants:revoke" + ], + "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 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": "RteOreH", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\",\n \"created_on\": \"\",\n \"last_successful_login\": \"\",\n \"expires_at\": \"\",\n \"locked_until\": \"\",\n \"has_password\": \"\",\n \"has_rsa_public_key\": \"\",\n \"rsa_public_key_fp\": \"\",\n \"rsa_public_key_2_fp\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "RteOreH", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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 (or alter an existing) user.", + "request": { + "method": "PUT", + "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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name" + ], + "variable": [ + { + "key": "name", + "value": "RteOreH", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Create a (or alter an existing) user. Even if the operation is just an alter, the full property set must be provided. Note that password is not currently altered by this operation but is supported for a newly-created object." + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "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 \"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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "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": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "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": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "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": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "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": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "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": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/users/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "users", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "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": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "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": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "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": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "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": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "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": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "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": "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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\"\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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\"\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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\"\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\",\n \"created_on\": \"\",\n \"last_successful_login\": \"\",\n \"expires_at\": \"\",\n \"locked_until\": \"\",\n \"has_password\": \"\",\n \"has_rsa_public_key\": \"\",\n \"rsa_public_key_fp\": \"\",\n \"rsa_public_key_2_fp\": \"\",\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\": \"ALL\",\n \"mins_to_bypass_mfa\": \"\",\n \"rsa_public_key\": \"\",\n \"rsa_public_key_2\": \"\",\n \"comment\": \"\",\n \"type\": \"\",\n \"enable_unredacted_query_syntax_error\": \"\",\n \"network_policy\": \"\",\n \"created_on\": \"\",\n \"last_successful_login\": \"\",\n \"expires_at\": \"\",\n \"locked_until\": \"\",\n \"has_password\": \"\",\n \"has_rsa_public_key\": \"\",\n \"rsa_public_key_fp\": \"\",\n \"rsa_public_key_2_fp\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}" + } + ] + } + ] + } + ] + } + ] + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + } + ] +} \ No newline at end of file diff --git a/releases/8.40/collections/Snowflake User Defined Function API.postman_collection.json b/releases/8.40/collections/Snowflake User Defined Function API.postman_collection.json new file mode 100644 index 0000000..cb324fe --- /dev/null +++ b/releases/8.40/collections/Snowflake User Defined Function API.postman_collection.json @@ -0,0 +1,5541 @@ +{ + "info": { + "_postman_id": "e7f8749c-20e4-4b7e-ac78-a8b9c29351b4", + "name": "Snowflake User Defined Function API", + "description": "The Snowflake User Defined Function API is a REST API that you can use to access, update, and perform certain actions on User Defined Function 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" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "databases", + "item": [ + { + "name": "{database}", + "item": [ + { + "name": "schemas", + "item": [ + { + "name": "{schema}", + "item": [ + { + "name": "user-defined-functions", + "item": [ + { + "name": "{nameWithArgs}", + "item": [ + { + "name": "Fetch a UDF", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-functions", + ":nameWithArgs" + ], + "variable": [ + { + "key": "database", + "value": "\"\"\"\"\"\"\"%f(\"\"\"\";\"\"\"", + "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": "\"\"\"\"\"\"\"%f(\"\"\"\";\"\"\"", + "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 UDF" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"name\": \"J\",\n \"arguments\": [\n {\n \"name\": \"mN\",\n \"datatype\": \"GEOMETRY\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"datatype\": \"TIMESTAMP_NTZ\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"Q\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\",\n \"is_volatile\": \"\"\n },\n \"is_temporary\": \"\",\n \"is_aggregate\": \"\",\n \"is_memoizable\": \"\",\n \"is_table_function\": \"\",\n \"valid_for_clustering\": \"\",\n \"is_secure\": \"\",\n \"comment\": \"\",\n \"body\": \"\",\n \"created_on\": \"\",\n \"schema_name\": \"XBOR$\",\n \"database_name\": \"joCDSs\",\n \"min_num_arguments\": \"\",\n \"max_num_arguments\": \"\",\n \"owner\": \"\\\"u\\\"\",\n \"owner_role_type\": \"S8nyFihW\",\n \"is_builtin\": \"\"\n}" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-functions", + ":nameWithArgs" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "nameWithArgs" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-functions", + ":nameWithArgs" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "nameWithArgs" + } + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-functions", + ":nameWithArgs" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "nameWithArgs" + } + ] + } + }, + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/:nameWithArgs", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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 UDF", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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": "\"\"\"\"\"\"\"%f(\"\"\"\";\"\"\"", + "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": "\"\"\"\"\"\"\"%f(\"\"\"\";\"\"\"", + "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 UDF" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/:nameWithArgs?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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": "{nameWithArgs}:rename", + "item": [ + { + "name": "Rename a UDF", + "request": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/{{nameWithArgs}}:rename?ifExists=false&targetDatabase=qnXsxm35dQJ&targetSchema=qnXsxm35dQJ&targetName=qnXsxm35dQJ", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-functions", + "{{nameWithArgs}}: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." + }, + { + "key": "targetDatabase", + "value": "qnXsxm35dQJ", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "qnXsxm35dQJ", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "key": "targetName", + "value": "qnXsxm35dQJ", + "description": "(Required) Name of the target resource." + } + ], + "variable": [ + { + "key": "database", + "value": "\"\"\"\"\"\"\"%f(\"\"\"\";\"\"\"", + "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": "\"\"\"\"\"\"\"%f(\"\"\"\";\"\"\"", + "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": "Rename a UDF" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/{{nameWithArgs}}:rename?ifExists=false&targetDatabase=qnXsxm35dQJ&targetSchema=qnXsxm35dQJ&targetName=qnXsxm35dQJ", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-functions", + "{{nameWithArgs}}: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." + }, + { + "key": "targetDatabase", + "value": "qnXsxm35dQJ", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "qnXsxm35dQJ", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "key": "targetName", + "value": "qnXsxm35dQJ", + "description": "(Required) Name of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/{{nameWithArgs}}:rename?ifExists=false&targetDatabase=qnXsxm35dQJ&targetSchema=qnXsxm35dQJ&targetName=qnXsxm35dQJ", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-functions", + "{{nameWithArgs}}: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." + }, + { + "key": "targetDatabase", + "value": "qnXsxm35dQJ", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "qnXsxm35dQJ", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "key": "targetName", + "value": "qnXsxm35dQJ", + "description": "(Required) Name of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/{{nameWithArgs}}:rename?ifExists=false&targetDatabase=qnXsxm35dQJ&targetSchema=qnXsxm35dQJ&targetName=qnXsxm35dQJ", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-functions", + "{{nameWithArgs}}: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." + }, + { + "key": "targetDatabase", + "value": "qnXsxm35dQJ", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "qnXsxm35dQJ", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "key": "targetName", + "value": "qnXsxm35dQJ", + "description": "(Required) Name of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/{{nameWithArgs}}:rename?ifExists=false&targetDatabase=qnXsxm35dQJ&targetSchema=qnXsxm35dQJ&targetName=qnXsxm35dQJ", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-functions", + "{{nameWithArgs}}: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." + }, + { + "key": "targetDatabase", + "value": "qnXsxm35dQJ", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "qnXsxm35dQJ", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "key": "targetName", + "value": "qnXsxm35dQJ", + "description": "(Required) Name of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/{{nameWithArgs}}:rename?ifExists=false&targetDatabase=qnXsxm35dQJ&targetSchema=qnXsxm35dQJ&targetName=qnXsxm35dQJ", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-functions", + "{{nameWithArgs}}: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." + }, + { + "key": "targetDatabase", + "value": "qnXsxm35dQJ", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "qnXsxm35dQJ", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "key": "targetName", + "value": "qnXsxm35dQJ", + "description": "(Required) Name of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/{{nameWithArgs}}:rename?ifExists=false&targetDatabase=qnXsxm35dQJ&targetSchema=qnXsxm35dQJ&targetName=qnXsxm35dQJ", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-functions", + "{{nameWithArgs}}: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." + }, + { + "key": "targetDatabase", + "value": "qnXsxm35dQJ", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "qnXsxm35dQJ", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "key": "targetName", + "value": "qnXsxm35dQJ", + "description": "(Required) Name of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/{{nameWithArgs}}:rename?ifExists=false&targetDatabase=qnXsxm35dQJ&targetSchema=qnXsxm35dQJ&targetName=qnXsxm35dQJ", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-functions", + "{{nameWithArgs}}: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." + }, + { + "key": "targetDatabase", + "value": "qnXsxm35dQJ", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "qnXsxm35dQJ", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "key": "targetName", + "value": "qnXsxm35dQJ", + "description": "(Required) Name of the target 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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/{{nameWithArgs}}:rename?ifExists=false&targetDatabase=qnXsxm35dQJ&targetSchema=qnXsxm35dQJ&targetName=qnXsxm35dQJ", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-functions", + "{{nameWithArgs}}: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." + }, + { + "key": "targetDatabase", + "value": "qnXsxm35dQJ", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "qnXsxm35dQJ", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "key": "targetName", + "value": "qnXsxm35dQJ", + "description": "(Required) Name of the target resource." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/{{nameWithArgs}}:rename?ifExists=false&targetDatabase=qnXsxm35dQJ&targetSchema=qnXsxm35dQJ&targetName=qnXsxm35dQJ", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-functions", + "{{nameWithArgs}}: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." + }, + { + "key": "targetDatabase", + "value": "qnXsxm35dQJ", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "qnXsxm35dQJ", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "key": "targetName", + "value": "qnXsxm35dQJ", + "description": "(Required) Name of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/{{nameWithArgs}}:rename?ifExists=false&targetDatabase=qnXsxm35dQJ&targetSchema=qnXsxm35dQJ&targetName=qnXsxm35dQJ", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-functions", + "{{nameWithArgs}}: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." + }, + { + "key": "targetDatabase", + "value": "qnXsxm35dQJ", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "qnXsxm35dQJ", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "key": "targetName", + "value": "qnXsxm35dQJ", + "description": "(Required) Name of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/{{nameWithArgs}}:rename?ifExists=false&targetDatabase=qnXsxm35dQJ&targetSchema=qnXsxm35dQJ&targetName=qnXsxm35dQJ", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-functions", + "{{nameWithArgs}}: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." + }, + { + "key": "targetDatabase", + "value": "qnXsxm35dQJ", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "qnXsxm35dQJ", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "key": "targetName", + "value": "qnXsxm35dQJ", + "description": "(Required) Name of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/{{nameWithArgs}}:rename?ifExists=false&targetDatabase=qnXsxm35dQJ&targetSchema=qnXsxm35dQJ&targetName=qnXsxm35dQJ", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-functions", + "{{nameWithArgs}}: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." + }, + { + "key": "targetDatabase", + "value": "qnXsxm35dQJ", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "qnXsxm35dQJ", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "key": "targetName", + "value": "qnXsxm35dQJ", + "description": "(Required) Name of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/{{nameWithArgs}}:rename?ifExists=false&targetDatabase=qnXsxm35dQJ&targetSchema=qnXsxm35dQJ&targetName=qnXsxm35dQJ", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-functions", + "{{nameWithArgs}}: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." + }, + { + "key": "targetDatabase", + "value": "qnXsxm35dQJ", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "qnXsxm35dQJ", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "key": "targetName", + "value": "qnXsxm35dQJ", + "description": "(Required) Name of the target 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": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions/{{nameWithArgs}}:rename?ifExists=false&targetDatabase=qnXsxm35dQJ&targetSchema=qnXsxm35dQJ&targetName=qnXsxm35dQJ", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-functions", + "{{nameWithArgs}}: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." + }, + { + "key": "targetDatabase", + "value": "qnXsxm35dQJ", + "description": "(Required) Database of the target resource. Defaults to the source's database" + }, + { + "key": "targetSchema", + "value": "qnXsxm35dQJ", + "description": "(Required) Schema of the target resource. Defaults to the source's schema" + }, + { + "key": "targetName", + "value": "qnXsxm35dQJ", + "description": "(Required) Name of the target 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}" + } + ] + } + ] + }, + { + "name": "Create a UDF", + "request": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"b\",\n \"arguments\": [\n {\n \"name\": \"ZI17jngxu1\",\n \"datatype\": \"TIMESTAMP_NTZ\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"-\\\"\\\"j6Ye\\\"\",\n \"datatype\": \"DOUBLE PRECISION\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"ceD\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\",\n \"is_volatile\": \"\"\n },\n \"is_temporary\": \"\",\n \"is_aggregate\": \"\",\n \"is_memoizable\": \"\",\n \"is_secure\": \"\",\n \"comment\": \"\",\n \"body\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + } + ], + "variable": [ + { + "key": "database", + "value": "\"\"\"\"\"\"\"%f(\"\"\"\";\"\"\"", + "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": "\"\"\"\"\"\"\"%f(\"\"\"\";\"\"\"", + "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 UDF" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"b\",\n \"arguments\": [\n {\n \"name\": \"ZI17jngxu1\",\n \"datatype\": \"TIMESTAMP_NTZ\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"-\\\"\\\"j6Ye\\\"\",\n \"datatype\": \"DOUBLE PRECISION\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"ceD\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\",\n \"is_volatile\": \"\"\n },\n \"is_temporary\": \"\",\n \"is_aggregate\": \"\",\n \"is_memoizable\": \"\",\n \"is_secure\": \"\",\n \"comment\": \"\",\n \"body\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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." + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"b\",\n \"arguments\": [\n {\n \"name\": \"ZI17jngxu1\",\n \"datatype\": \"TIMESTAMP_NTZ\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"-\\\"\\\"j6Ye\\\"\",\n \"datatype\": \"DOUBLE PRECISION\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"ceD\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\",\n \"is_volatile\": \"\"\n },\n \"is_temporary\": \"\",\n \"is_aggregate\": \"\",\n \"is_memoizable\": \"\",\n \"is_secure\": \"\",\n \"comment\": \"\",\n \"body\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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." + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"b\",\n \"arguments\": [\n {\n \"name\": \"ZI17jngxu1\",\n \"datatype\": \"TIMESTAMP_NTZ\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"-\\\"\\\"j6Ye\\\"\",\n \"datatype\": \"DOUBLE PRECISION\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"ceD\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\",\n \"is_volatile\": \"\"\n },\n \"is_temporary\": \"\",\n \"is_aggregate\": \"\",\n \"is_memoizable\": \"\",\n \"is_secure\": \"\",\n \"comment\": \"\",\n \"body\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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." + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"b\",\n \"arguments\": [\n {\n \"name\": \"ZI17jngxu1\",\n \"datatype\": \"TIMESTAMP_NTZ\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"-\\\"\\\"j6Ye\\\"\",\n \"datatype\": \"DOUBLE PRECISION\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"ceD\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\",\n \"is_volatile\": \"\"\n },\n \"is_temporary\": \"\",\n \"is_aggregate\": \"\",\n \"is_memoizable\": \"\",\n \"is_secure\": \"\",\n \"comment\": \"\",\n \"body\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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." + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"b\",\n \"arguments\": [\n {\n \"name\": \"ZI17jngxu1\",\n \"datatype\": \"TIMESTAMP_NTZ\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"-\\\"\\\"j6Ye\\\"\",\n \"datatype\": \"DOUBLE PRECISION\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"ceD\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\",\n \"is_volatile\": \"\"\n },\n \"is_temporary\": \"\",\n \"is_aggregate\": \"\",\n \"is_memoizable\": \"\",\n \"is_secure\": \"\",\n \"comment\": \"\",\n \"body\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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." + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"b\",\n \"arguments\": [\n {\n \"name\": \"ZI17jngxu1\",\n \"datatype\": \"TIMESTAMP_NTZ\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"-\\\"\\\"j6Ye\\\"\",\n \"datatype\": \"DOUBLE PRECISION\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"ceD\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\",\n \"is_volatile\": \"\"\n },\n \"is_temporary\": \"\",\n \"is_aggregate\": \"\",\n \"is_memoizable\": \"\",\n \"is_secure\": \"\",\n \"comment\": \"\",\n \"body\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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." + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"b\",\n \"arguments\": [\n {\n \"name\": \"ZI17jngxu1\",\n \"datatype\": \"TIMESTAMP_NTZ\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"-\\\"\\\"j6Ye\\\"\",\n \"datatype\": \"DOUBLE PRECISION\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"ceD\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\",\n \"is_volatile\": \"\"\n },\n \"is_temporary\": \"\",\n \"is_aggregate\": \"\",\n \"is_memoizable\": \"\",\n \"is_secure\": \"\",\n \"comment\": \"\",\n \"body\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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." + }, + { + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"b\",\n \"arguments\": [\n {\n \"name\": \"ZI17jngxu1\",\n \"datatype\": \"TIMESTAMP_NTZ\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"-\\\"\\\"j6Ye\\\"\",\n \"datatype\": \"DOUBLE PRECISION\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"ceD\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\",\n \"is_volatile\": \"\"\n },\n \"is_temporary\": \"\",\n \"is_aggregate\": \"\",\n \"is_memoizable\": \"\",\n \"is_secure\": \"\",\n \"comment\": \"\",\n \"body\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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." + }, + { + "key": "copyGrants", + "value": "false", + "description": "Query parameter to enable copy grants when creating the object." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"b\",\n \"arguments\": [\n {\n \"name\": \"ZI17jngxu1\",\n \"datatype\": \"TIMESTAMP_NTZ\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"-\\\"\\\"j6Ye\\\"\",\n \"datatype\": \"DOUBLE PRECISION\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"ceD\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\",\n \"is_volatile\": \"\"\n },\n \"is_temporary\": \"\",\n \"is_aggregate\": \"\",\n \"is_memoizable\": \"\",\n \"is_secure\": \"\",\n \"comment\": \"\",\n \"body\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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." + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"b\",\n \"arguments\": [\n {\n \"name\": \"ZI17jngxu1\",\n \"datatype\": \"TIMESTAMP_NTZ\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"-\\\"\\\"j6Ye\\\"\",\n \"datatype\": \"DOUBLE PRECISION\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"ceD\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\",\n \"is_volatile\": \"\"\n },\n \"is_temporary\": \"\",\n \"is_aggregate\": \"\",\n \"is_memoizable\": \"\",\n \"is_secure\": \"\",\n \"comment\": \"\",\n \"body\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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." + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"b\",\n \"arguments\": [\n {\n \"name\": \"ZI17jngxu1\",\n \"datatype\": \"TIMESTAMP_NTZ\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"-\\\"\\\"j6Ye\\\"\",\n \"datatype\": \"DOUBLE PRECISION\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"ceD\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\",\n \"is_volatile\": \"\"\n },\n \"is_temporary\": \"\",\n \"is_aggregate\": \"\",\n \"is_memoizable\": \"\",\n \"is_secure\": \"\",\n \"comment\": \"\",\n \"body\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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." + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"b\",\n \"arguments\": [\n {\n \"name\": \"ZI17jngxu1\",\n \"datatype\": \"TIMESTAMP_NTZ\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"-\\\"\\\"j6Ye\\\"\",\n \"datatype\": \"DOUBLE PRECISION\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"ceD\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\",\n \"is_volatile\": \"\"\n },\n \"is_temporary\": \"\",\n \"is_aggregate\": \"\",\n \"is_memoizable\": \"\",\n \"is_secure\": \"\",\n \"comment\": \"\",\n \"body\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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." + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"b\",\n \"arguments\": [\n {\n \"name\": \"ZI17jngxu1\",\n \"datatype\": \"TIMESTAMP_NTZ\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"-\\\"\\\"j6Ye\\\"\",\n \"datatype\": \"DOUBLE PRECISION\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"ceD\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\",\n \"is_volatile\": \"\"\n },\n \"is_temporary\": \"\",\n \"is_aggregate\": \"\",\n \"is_memoizable\": \"\",\n \"is_secure\": \"\",\n \"comment\": \"\",\n \"body\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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." + }, + { + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"b\",\n \"arguments\": [\n {\n \"name\": \"ZI17jngxu1\",\n \"datatype\": \"TIMESTAMP_NTZ\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"-\\\"\\\"j6Ye\\\"\",\n \"datatype\": \"DOUBLE PRECISION\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"ceD\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\",\n \"is_volatile\": \"\"\n },\n \"is_temporary\": \"\",\n \"is_aggregate\": \"\",\n \"is_memoizable\": \"\",\n \"is_secure\": \"\",\n \"comment\": \"\",\n \"body\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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." + }, + { + "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": "List UDFs", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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": "\"\"\"\"\"\"\"%f(\"\"\"\";\"\"\"", + "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": "\"\"\"\"\"\"\"%f(\"\"\"\";\"\"\"", + "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": "List UDFs" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"L\",\n \"arguments\": [\n {\n \"name\": \"Vi9VTTgw_b8\",\n \"datatype\": \"DECIMAL\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"datatype\": \"GEOGRAPHY\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"\\\"W\\\"\\\".'\\\"\\\"d\\\"\\\"\\\"\\\"\\\"\\\"=\\\"\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\",\n \"is_volatile\": \"\"\n },\n \"is_temporary\": \"\",\n \"is_aggregate\": \"\",\n \"is_memoizable\": \"\",\n \"is_table_function\": \"\",\n \"valid_for_clustering\": \"\",\n \"is_secure\": \"\",\n \"comment\": \"\",\n \"body\": \"\",\n \"created_on\": \"\",\n \"schema_name\": \"SqHTl$t\",\n \"database_name\": \"\\\"\\\"\\\"\\\"\",\n \"min_num_arguments\": \"\",\n \"max_num_arguments\": \"\",\n \"owner\": \"gWB2Iq4\",\n \"owner_role_type\": \"\\\"\\\"\\\"\\\"\",\n \"is_builtin\": \"\"\n },\n {\n \"name\": \"zq1HyaPL2v\",\n \"arguments\": [\n {\n \"name\": \"WEW\",\n \"datatype\": \"BINARY\",\n \"default_value\": \"\"\n },\n {\n \"name\": \"kAgMM4\",\n \"datatype\": \"BIGINT\",\n \"default_value\": \"\"\n }\n ],\n \"return_type\": {\n \"type\": \"wMfMnf\"\n },\n \"language_config\": {\n \"language\": \"\",\n \"called_on_null_input\": \"\",\n \"is_volatile\": \"\"\n },\n \"is_temporary\": \"\",\n \"is_aggregate\": \"\",\n \"is_memoizable\": \"\",\n \"is_table_function\": \"\",\n \"valid_for_clustering\": \"\",\n \"is_secure\": \"\",\n \"comment\": \"\",\n \"body\": \"\",\n \"created_on\": \"\",\n \"schema_name\": \"wPyH4hxN\",\n \"database_name\": \"Ch\",\n \"min_num_arguments\": \"\",\n \"max_num_arguments\": \"\",\n \"owner\": \"\\\"9=\\\"\\\"\\\"\",\n \"owner_role_type\": \"\\\"\\\"\\\"\\\"\\\"MJ\\\"\\\"9L\\\"\\\"w\\\"\\\"\\\"\\\"\\\"\",\n \"is_builtin\": \"\"\n }\n]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/user-defined-functions?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "user-defined-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}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + }, + { + "key": "nameWithArgs", + "value": "" + } + ] +} \ No newline at end of file diff --git a/releases/8.40/collections/Snowflake View API.postman_collection.json b/releases/8.40/collections/Snowflake View API.postman_collection.json new file mode 100644 index 0000000..0162479 --- /dev/null +++ b/releases/8.40/collections/Snowflake View API.postman_collection.json @@ -0,0 +1,4595 @@ +{ + "info": { + "_postman_id": "e9276388-8466-40cc-806b-2f14b6e02ff3", + "name": "Snowflake View API", + "description": "The Snowflake View API is a REST API that you can use to access, update, and perform certain actions on View 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" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "databases", + "item": [ + { + "name": "{database}", + "item": [ + { + "name": "schemas", + "item": [ + { + "name": "{schema}", + "item": [ + { + "name": "views", + "item": [ + { + "name": "{name}", + "item": [ + { + "name": "Fetch a view", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views", + ":name" + ], + "variable": [ + { + "key": "database", + "value": "A5", + "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": "A5", + "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": "A5", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Fetch a view" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views", + ":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 \"columns\": [\n {\n \"name\": \"\",\n \"comment\": \"\",\n \"datatype\": \"\"\n },\n {\n \"name\": \"\",\n \"comment\": \"\",\n \"datatype\": \"\"\n }\n ],\n \"query\": \"\",\n \"secure\": \"\",\n \"kind\": \"PERMANENT\",\n \"recursive\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views", + ":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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views", + ":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 view", + "request": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views", + ":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": "A5", + "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": "A5", + "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": "A5", + "description": "(Required) Identifier (i.e. name) for the resource." + } + ] + }, + "description": "Delete a view" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views", + ":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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views", + ":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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views", + ":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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views", + ":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 views", + "request": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views?like=&startsWith=&showLimit=&fromName=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views" + ], + "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 view." + } + ], + "variable": [ + { + "key": "database", + "value": "A5", + "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": "A5", + "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": "List views" + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views?like=&startsWith=&showLimit=&fromName=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views" + ], + "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 view." + } + ], + "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 \"columns\": [\n {\n \"name\": \"\",\n \"comment\": \"\",\n \"datatype\": \"\"\n },\n {\n \"name\": \"\",\n \"comment\": \"\",\n \"datatype\": \"\"\n }\n ],\n \"query\": \"\",\n \"secure\": \"\",\n \"kind\": \"PERMANENT\",\n \"recursive\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\"\n },\n {\n \"name\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"comment\": \"\",\n \"datatype\": \"\"\n },\n {\n \"name\": \"\",\n \"comment\": \"\",\n \"datatype\": \"\"\n }\n ],\n \"query\": \"\",\n \"secure\": \"\",\n \"kind\": \"PERMANENT\",\n \"recursive\": \"\",\n \"comment\": \"\",\n \"created_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views?like=&startsWith=&showLimit=&fromName=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views" + ], + "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 view." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views?like=&startsWith=&showLimit=&fromName=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views" + ], + "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 view." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views?like=&startsWith=&showLimit=&fromName=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views" + ], + "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 view." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views?like=&startsWith=&showLimit=&fromName=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views" + ], + "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 view." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views?like=&startsWith=&showLimit=&fromName=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views" + ], + "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 view." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views?like=&startsWith=&showLimit=&fromName=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views" + ], + "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 view." + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views?like=&startsWith=&showLimit=&fromName=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views" + ], + "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 view." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views?like=&startsWith=&showLimit=&fromName=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views" + ], + "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 view." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views?like=&startsWith=&showLimit=&fromName=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views" + ], + "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 view." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views?like=&startsWith=&showLimit=&fromName=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views" + ], + "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 view." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views?like=&startsWith=&showLimit=&fromName=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views" + ], + "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 view." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views?like=&startsWith=&showLimit=&fromName=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views" + ], + "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 view." + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views?like=&startsWith=&showLimit=&fromName=&deep=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views" + ], + "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 view." + } + ], + "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 view", + "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 \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"comment\": \"\"\n }\n ],\n \"query\": \"\",\n \"secure\": \"\",\n \"kind\": \"TEMPORARY\",\n \"recursive\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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": "A5", + "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": "A5", + "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 view" + }, + "response": [ + { + "name": "Successful request.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"comment\": \"\"\n }\n ],\n \"query\": \"\",\n \"secure\": \"\",\n \"kind\": \"TEMPORARY\",\n \"recursive\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"comment\": \"\"\n }\n ],\n \"query\": \"\",\n \"secure\": \"\",\n \"kind\": \"TEMPORARY\",\n \"recursive\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"comment\": \"\"\n }\n ],\n \"query\": \"\",\n \"secure\": \"\",\n \"kind\": \"TEMPORARY\",\n \"recursive\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"comment\": \"\"\n }\n ],\n \"query\": \"\",\n \"secure\": \"\",\n \"kind\": \"TEMPORARY\",\n \"recursive\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"comment\": \"\"\n }\n ],\n \"query\": \"\",\n \"secure\": \"\",\n \"kind\": \"TEMPORARY\",\n \"recursive\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"comment\": \"\"\n }\n ],\n \"query\": \"\",\n \"secure\": \"\",\n \"kind\": \"TEMPORARY\",\n \"recursive\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"comment\": \"\"\n }\n ],\n \"query\": \"\",\n \"secure\": \"\",\n \"kind\": \"TEMPORARY\",\n \"recursive\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"comment\": \"\"\n }\n ],\n \"query\": \"\",\n \"secure\": \"\",\n \"kind\": \"TEMPORARY\",\n \"recursive\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"comment\": \"\"\n }\n ],\n \"query\": \"\",\n \"secure\": \"\",\n \"kind\": \"TEMPORARY\",\n \"recursive\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"comment\": \"\"\n }\n ],\n \"query\": \"\",\n \"secure\": \"\",\n \"kind\": \"TEMPORARY\",\n \"recursive\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"comment\": \"\"\n }\n ],\n \"query\": \"\",\n \"secure\": \"\",\n \"kind\": \"TEMPORARY\",\n \"recursive\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"comment\": \"\"\n }\n ],\n \"query\": \"\",\n \"secure\": \"\",\n \"kind\": \"TEMPORARY\",\n \"recursive\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"comment\": \"\"\n }\n ],\n \"query\": \"\",\n \"secure\": \"\",\n \"kind\": \"TEMPORARY\",\n \"recursive\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\",\n \"columns\": [\n {\n \"name\": \"\",\n \"comment\": \"\"\n },\n {\n \"name\": \"\",\n \"comment\": \"\"\n }\n ],\n \"query\": \"\",\n \"secure\": \"\",\n \"kind\": \"TEMPORARY\",\n \"recursive\": \"\",\n \"comment\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/views?createMode=errorIfExists©Grants=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "views" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists", + "description": "Query parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically 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}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + } + ] +} \ No newline at end of file diff --git a/releases/8.40/collections/Snowflake Warehouse API.postman_collection.json b/releases/8.40/collections/Snowflake Warehouse API.postman_collection.json new file mode 100644 index 0000000..d70e517 --- /dev/null +++ b/releases/8.40/collections/Snowflake Warehouse API.postman_collection.json @@ -0,0 +1,8660 @@ +{ + "info": { + "_postman_id": "e26a5ce3-e2cb-4397-a872-a140e542daf6", + "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" + }, + "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": "\"\"\"\"\"ye0\"\"\"\"\"", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"I\\\"\\\"e\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\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\": \"\\\"\\\"\\\"<\\\"\",\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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "\"\"\"\"\"ye0\"\"\"\"\"", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "variable": [ + { + "key": "name", + "value": "\"\"\"\"\"ye0\"\"\"\"\"", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/warehouses/{{name}}:use", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "warehouses", + "{{name}}:use" + ] + } + }, + "status": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"tM4I$Iz\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"sA9NRzVqLLR\",\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}", + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + } + }, + { + "key": "Link", + "value": "", + "description": { + "content": "", + "type": "text/plain" + } + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"\\\"\\\"\\\"/rg\\\"\\\"N\\\"\\\"\\\"\",\n \"warehouse_type\": \"\",\n \"warehouse_size\": \"\",\n \"wait_for_completion\": \"true\",\n \"max_cluster_count\": \"\",\n \"min_cluster_count\": \"\",\n \"scaling_policy\": \"\",\n \"auto_suspend\": \"\",\n \"auto_resume\": \"true\",\n \"initially_suspended\": \"true\",\n \"resource_monitor\": \"\\\"\\\"\\\"QY\\\"\\\"V\\\"\\\"\\\"\",\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\": \"W3CcSHi\",\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\": \"true\",\n \"initially_suspended\": \"false\",\n \"resource_monitor\": \"QVz1sn$\",\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]" + }, + { + "name": "Successfully accepted the request, but it is not completed yet.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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": "Request Timeout", + "code": 408, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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" + }, + { + "key": "Authorization", + "value": "Bearer ", + "description": "Added as a part of security scheme: bearer" + } + ], + "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}" + } + ] + } + ] + } + ] + } + ] + } + ], + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + }, + { + "key": "name", + "value": "\"\"\"\"\"ye0\"\"\"\"\"" + } + ] +} \ No newline at end of file diff --git a/releases/8.40/specifications/account.yaml b/releases/8.40/specifications/account.yaml new file mode 100644 index 0000000..8b525f9 --- /dev/null +++ b/releases/8.40/specifications/account.yaml @@ -0,0 +1,423 @@ +openapi: 3.0.0 +servers: +- description: Snowflake Account API + url: https://org-account.snowflakecomputing.com +info: + version: 0.0.1 + title: Snowflake Account API + description: The Snowflake Account API is a REST API that you can use to access, + update, and perform certain actions on Account resource in Snowflake. + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/accounts: + get: + summary: Lists accounts. + tags: + - account + description: Lists the accessible accounts. + operationId: listAccounts + parameters: + - $ref: common.yaml#/components/parameters/like + - $ref: common.yaml#/components/parameters/showLimit + - name: history + in: query + description: Optionally includes dropped accounts 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/Account' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + post: + summary: Creates a account. + tags: + - account + description: Creates a account. You must provide the full account definition + when creating a account. + operationId: createAccount + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Account' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/accounts/{name}: + delete: + summary: Deletes a account. + tags: + - account + description: Deletes the specified account. If you enable the `ifExists` parameter, + the operation succeeds even if the account does not exist. Otherwise, a 404 + failure is returned if the account does not exist. if the drop is unsuccessful. + operationId: deleteAccount + parameters: + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/ifExists + - name: gracePeriodInDays + in: query + description: "Specifies the number of days during which the account can be\ + \ restored (\u201Cundropped\u201D). The minimum is 3 days and the maximum\ + \ is 90 days." + schema: + type: integer + required: true + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/accounts/{name}:undrop: + post: + summary: Restore a account. + tags: + - account + description: Restores a dropped account that has not yet been permanently deleted + (a dropped account that is within its grace period). + operationId: UndropAccount + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +components: + schemas: + Account: + type: object + description: Snowflake account object. + properties: + organization_name: + type: string + readOnly: true + description: Name of the organization. + name: + $ref: ./common.yaml#/components/schemas/Identifier + description: User-defined name that identifies an account within the organization. + region_group: + type: string + description: Region group where the account is located. Note - This column + is only displayed for organizations that span multiple region groups. + region: + type: string + description: Snowflake Region where the account is located. A Snowflake + Region is a distinct location within a cloud platform region that is isolated + from other Snowflake Regions. A Snowflake Region can be either multi-tenant + or single-tenant (for a Virtual Private Snowflake account). + edition: + type: string + description: Snowflake Edition of the account. + enum: + - STANDARD + - ENTERPRISE + - BUSINESS_CRITICAL + created_on: + type: string + format: date-time + readOnly: true + description: Date and time the account was created. + account_url: + type: string + readOnly: true + description: Preferred Snowflake account URL that includes the values of + organization_name and account_name. + account_locator: + type: string + readOnly: true + description: System-assigned identifier of the acccount. + account_locator_url: + type: string + readOnly: true + description: Legacy Snowflake account URL syntax that includes the region_name + and account_locator. + managed_accounts: + type: integer + readOnly: true + format: int64 + description: Indicates how many managed accounts have been created by the + account. + consumption_billing_entity_name: + type: string + readOnly: true + description: Name of the consumption billing entity. + marketplace_consumer_billing_entity_name: + type: string + readOnly: true + description: Name of the marketplace consumer billing entity. + marketplace_provider_billing_entity_name: + type: string + readOnly: true + description: Name of the marketplace provider billing entity. + old_account_url: + type: string + readOnly: true + description: If the original account URL was saved when the account was + renamed, provides the original URL. If the original account URL was dropped, + the value is NULL even if the account was renamed + comment: + type: string + description: Optional comment in which to store information related to the + account. + is_org_admin: + type: boolean + readOnly: true + description: Indicates whether the ORGADMIN role is enabled in an account. + If TRUE, the role is enabled. + 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 account was dropped. + scheduled_deletion_time: + type: string + format: date-time + readOnly: true + nullable: true + description: Date and time when the account is scheduled to be permanently + deleted. Accounts are deleted within one hour after the scheduled time. + restored_on: + type: string + format: date-time + readOnly: true + nullable: true + description: Date and time when the account was last restored. + account_old_url_saved_on: + type: string + format: date-time + readOnly: true + description: If the original account URL was saved when the account was + renamed, provides the date and time when the original account URL was + saved. + account_old_url_last_used: + type: string + format: date-time + readOnly: true + description: If the original account URL was saved when the account was + renamed, indicates the last time the account was accessed using the original + URL. + organization_old_url: + type: string + readOnly: true + description: "If the account\u2019s organization was changed in a way that\ + \ created a new account URL and the original account URL was saved, provides\ + \ the original account URL. If the original account URL was dropped, the\ + \ value is NULL even if the organization changed." + organization_old_url_saved_on: + type: string + readOnly: true + format: date-time + description: "If the account\u2019s organization was changed in a way that\ + \ created a new account URL and the original account URL was saved, provides\ + \ the date and time when the original account URL was saved." + organization_old_url_last_used: + type: string + readOnly: true + format: date-time + description: "If the account\u2019s organization was changed in a way that\ + \ created a new account URL and the original account URL was saved, indicates\ + \ the last time the account was accessed using the original account URL." + organization_URL_expiration_on: + type: string + format: date-time + readOnly: true + nullable: true + description: "If the account\u2019s organization was changed in a way that\ + \ created a new account URL and the original account URL was saved, provides\ + \ the date and time when the original account URL will be dropped. Dropped\ + \ URLs cannot be used to access the account." + moved_on: + type: string + format: date-time + readOnly: true + nullable: true + description: Date and time when the account was moved to a different organization. + is_events_account: + type: boolean + readOnly: true + description: Indicates whether an account is an events account. For more + information, see Set up logging and event sharing for an application. + moved_to_organization: + type: string + readOnly: true + description: If the account was moved to a different organization, provides + the name of that organization. + admin_name: + type: string + description: Name of the account administrator. + writeOnly: true + nullable: true + admin_password: + type: string + description: Password for the account administrator. + writeOnly: true + format: password + admin_rsa_public_key: + type: string + description: RSA public key for the account administrator. + writeOnly: true + format: password + admin_user_type: + type: string + description: User type of the account administrator. + writeOnly: true + first_name: + type: string + description: First name of the account administrator. + writeOnly: true + last_name: + type: string + description: Last name of the account administrator. + writeOnly: true + email: + type: string + description: Email address of the account administrator. + writeOnly: true + nullable: true + must_change_password: + type: boolean + description: Indicates whether the account administrator must change the + password at the next login. + default: false + writeOnly: true + polaris: + type: boolean + description: Indicates whether the account is a Polaris account. + default: false + writeOnly: true + required: + - name + - admin_name + - email + - edition + securitySchemes: + KeyPair: + $ref: common.yaml#/components/securitySchemes/KeyPair + ExternalOAuth: + $ref: common.yaml#/components/securitySchemes/ExternalOAuth + SnowflakeOAuth: + $ref: common.yaml#/components/securitySchemes/SnowflakeOAuth +security: +- KeyPair: [] +- ExternalOAuth: [] +- SnowflakeOAuth: [] +tags: +- name: account diff --git a/releases/8.40/specifications/alert.yaml b/releases/8.40/specifications/alert.yaml new file mode 100644 index 0000000..77f1ba4 --- /dev/null +++ b/releases/8.40/specifications/alert.yaml @@ -0,0 +1,484 @@ +openapi: 3.0.0 +servers: +- description: Snowflake REST Server + url: https://org-account.snowflakecomputing.com +info: + version: 0.0.1 + title: Snowflake Alert API + description: The Snowflake Alert API is a REST API that you can use to access, update, + and perform certain actions on Alert resource in a Snowflake database. + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/databases/{database}/schemas/{schema}/alerts: + get: + summary: List alerts + tags: + - alert + description: List alerts + operationId: listAlerts + 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/Alert' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + post: + summary: Create an alert + tags: + - alert + description: Create an alert + operationId: createAlert + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/createMode + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Alert' + /api/v2/databases/{database}/schemas/{schema}/alerts/{name}: + get: + summary: Fetch an alert + tags: + - alert + description: Fetch an alert + operationId: fetchAlert + 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/Alert' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + delete: + summary: Delete an alert + tags: + - alert + description: Delete an alert + operationId: deleteAlert + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/alerts/{name}:clone: + post: + summary: Create a new alert by cloning from the specified resource + tags: + - alert + description: Create a new alert by cloning from the specified resource + operationId: cloneAlert + 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 + - name: targetDatabase + description: Database of the newly created resource. Defaults to the source's + database + in: query + required: true + schema: + type: string + - name: targetSchema + description: Schema of the newly created resource. Defaults to the source's + schema + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AlertClone' + /api/v2/databases/{database}/schemas/{schema}/alerts/{name}:execute: + post: + summary: Execute an alert + tags: + - alert + description: Execute an alert + operationId: executeAlert + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +components: + schemas: + Alert: + type: object + description: A Snowflake alert + properties: + name: + type: string + description: Name of the alert + comment: + type: string + description: user comment associated to an object in the dictionary + schedule: + $ref: '#/components/schemas/Schedule' + description: The schedule the alert runs under + warehouse: + type: string + description: The warehouse the alert runs in + condition: + type: string + description: The SQL statement that must be evaluated to determine whether + to trigger the alert + action: + type: string + description: The SQL statement to execute when the alert is triggered + created_on: + type: string + format: date-time + readOnly: true + description: Date and time when the alert was created. + database_name: + type: string + readOnly: true + description: Database in which the alert is stored + schema_name: + type: string + readOnly: true + description: Schema in which the alert is stored + owner: + type: string + readOnly: true + description: Role that owns the alert + owner_role_type: + type: string + readOnly: true + description: The type of role that owns the alert + state: + type: string + readOnly: true + description: The current state of the alert + required: + - name + - schedule + - condition + - action + Schedule: + type: object + properties: + schedule_type: + type: string + description: Type of the schedule, can be either CRON_TYPE or MINUTES_TYPE + required: + - schedule_type + discriminator: + propertyName: schedule_type + mapping: + CRON_TYPE: CronSchedule + SCHEDULE_TYPE: MinutesSchedule + CronSchedule: + type: object + allOf: + - $ref: '#/components/schemas/Schedule' + properties: + cron_expr: + type: string + description: A cron expression for the scheduled execution. + timezone: + type: string + description: The time zone for the schedule. + required: + - cron_expr + - timezone + MinutesSchedule: + type: object + allOf: + - $ref: '#/components/schemas/Schedule' + properties: + minutes: + type: integer + required: + - minutes + AlertClone: + type: object + properties: + name: + type: string + description: Name of the alert + point_of_time: + $ref: '#/components/schemas/PointOfTime' + 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. + + ' + required: + - name + PointOfTime: + type: object + properties: + point_of_time_type: + type: string + description: 'Type of the point of time. Possible values include: timestamp, + offset, statement' + reference: + type: string + enum: + - at + - before + x-enum-varnames: + - AT + - BEFORE + description: Relation to the point of time. Currently, the API supports + `at` and `before` + required: + - point_of_time_type + - reference + discriminator: + propertyName: point_of_time_type + mapping: + timestamp: PointOfTimeTimestamp + offset: PointOfTimeOffset + statement: PointOfTimeStatement + PointOfTimeTimestamp: + type: object + allOf: + - $ref: '#/components/schemas/PointOfTime' + properties: + timestamp: + type: string + description: Timestamp of the point of time. + required: + - timestamp + PointOfTimeOffset: + type: object + allOf: + - $ref: '#/components/schemas/PointOfTime' + properties: + offset: + type: string + description: Point of time identified by an offset in reference to the current + time, such as `10 min`. + required: + - offset + PointOfTimeStatement: + type: object + allOf: + - $ref: '#/components/schemas/PointOfTime' + properties: + statement: + type: string + description: Statement of the point of time. + required: + - statement + securitySchemes: + KeyPair: + $ref: common.yaml#/components/securitySchemes/KeyPair + ExternalOAuth: + $ref: common.yaml#/components/securitySchemes/ExternalOAuth + SnowflakeOAuth: + $ref: common.yaml#/components/securitySchemes/SnowflakeOAuth +security: +- KeyPair: [] +- ExternalOAuth: [] +- SnowflakeOAuth: [] diff --git a/releases/8.40/specifications/catalog-integration.yaml b/releases/8.40/specifications/catalog-integration.yaml new file mode 100644 index 0000000..3a7c2e6 --- /dev/null +++ b/releases/8.40/specifications/catalog-integration.yaml @@ -0,0 +1,346 @@ +openapi: 3.0.0 +servers: +- description: Snowflake REST Server + url: https://org-account.snowflakecomputing.com +info: + version: 0.0.1 + title: Snowflake Catalog Integration API + description: The Snowflake Catalog Integration API is a REST API that you can use + to access, update, and perform certain actions on Catalog Integration resource + in a Snowflake database. + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/catalog-integrations: + get: + summary: List catalog integrations. + tags: + - catalog-integration + description: List catalog integrations. + operationId: listCatalogIntegrations + 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/CatalogIntegration' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + post: + summary: Create a catalog integration. + tags: + - catalog-integration + description: Create a catalog integration. + operationId: createCatalogIntegration + parameters: + - $ref: common.yaml#/components/parameters/createMode + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CatalogIntegration' + /api/v2/catalog-integrations/{name}: + get: + summary: Fetch a catalog integration. + tags: + - catalog-integration + description: Fetch a catalog integration. + operationId: fetchCatalogIntegration + 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/CatalogIntegration' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + delete: + summary: Delete a catalog integration. + tags: + - catalog-integration + description: Delete a catalog integration. + operationId: deleteCatalogIntegration + parameters: + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/ifExists + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +components: + schemas: + CatalogIntegration: + type: object + description: Catalog integration + properties: + name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Name of the catalog integration. + catalog: + $ref: '#/components/schemas/Catalog' + description: Type of catalog and its parameters. + table_format: + type: string + enum: + - ICEBERG + description: Table format of the catalog. + enabled: + type: boolean + description: 'whether this catalog integration is available to use for Iceberg + tables. ' + comment: + type: string + description: Comment. + type: + type: string + readOnly: true + description: Type of the integration. Always CATALOG. + category: + type: string + readOnly: true + description: Category of the integration. Always CATALOG. + created_on: + type: string + format: date-time + readOnly: true + description: Date and time when the catalog integration was created. + required: + - name + - catalog + - table_format + - enabled + Catalog: + type: object + properties: + catalog_source: + type: string + enum: + - GLUE + - OBJECT_STORE + - POLARIS + description: Type of external catalog + required: + - catalog_source + discriminator: + propertyName: catalog_source + mapping: + GLUE: Glue + OBJECT_STORE: ObjectStore + POLARIS: Polaris + Glue: + type: object + allOf: + - $ref: '#/components/schemas/Catalog' + properties: + glue_aws_role_arn: + type: string + description: ARN for AWS role to assume + glue_catalog_id: + type: string + description: Glue catalog id + glue_region: + type: string + description: AWS region of the Glue catalog. Must be specified if the Snowflake + account is not hosted on AWS. + catalog_namespace: + type: string + description: default AWS Glue catalog namespace for all Iceberg table that + use this catalog integration + required: + - glue_aws_role_arn + - glue_catalog_id + - catalog_namespace + ObjectStore: + type: object + allOf: + - $ref: '#/components/schemas/Catalog' + Polaris: + type: object + allOf: + - $ref: '#/components/schemas/Catalog' + properties: + catalog_namespace: + type: string + description: Default Polaris namespace used by all Iceberg tables associated + with this catalog integration + rest_config: + $ref: '#/components/schemas/RestConfig' + description: Information about the Polaris catalog account and catalog name. + rest_authentication: + $ref: '#/components/schemas/RestAuthentication' + description: Authentication details that Snowflake uses to connect to the + Polaris catalog. + required: + - catalog_namespace + - rest_config + - rest_authentication + RestConfig: + type: object + properties: + catalog_uri: + type: string + description: Customer's Polaris account locator URL + warehouse: + type: string + description: Name of the catalog to use in Polaris + required: + - catalog_uri + - warehouse + RestAuthentication: + type: object + properties: + type: + type: string + enum: + - OAUTH + description: Authentication type. + required: + - type + discriminator: + propertyName: type + mapping: + OAUTH: OAuth + OAuth: + type: object + allOf: + - $ref: '#/components/schemas/RestAuthentication' + properties: + oauth_client_id: + type: string + description: The client ID of the OAuth2 credential associated with the + Polaris service connection. + oauth_client_secret: + type: string + description: The secret for the OAuth2 credential associated with the Polaris + service connection. + oauth_allowed_scopes: + type: array + items: + type: string + description: The scope of the OAuth token. Only one scope is included in + the Iceberg REST API specification, but catalogs can support more than + one scope in their implementation. + required: + - oauth_client_id + - oauth_client_secret + - oauth_allowed_scopes diff --git a/releases/8.40/specifications/common.yaml b/releases/8.40/specifications/common.yaml new file mode 100644 index 0000000..b254b0d --- /dev/null +++ b/releases/8.40/specifications/common.yaml @@ -0,0 +1,587 @@ +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 + application: + name: application + description: Identifier (i.e. name) for the application to which the resource + belongs. You can use the `/api/v2/applications/{application}` GET request + to get a list of available applications. + required: true + in: path + schema: + example: TEST_APPLICATION + $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 + mode: + name: mode + description: 'Query parameter determines whether the revoke operation succeeds + or fails for the privileges, based on the whether the privileges had been + re-granted to another role. + + - restrict: If the privilege being revoked has been re-granted to another + role, the REVOKE command fails. + + - cascade: If the privilege being revoked has been re-granted, the REVOKE + command recursively revokes these dependent grants. If the same privilege + on an object has been granted to the target role by a different grantor (parallel + grant), that grant is not affected and the target role retains the privilege.' + in: query + schema: + type: string + enum: + - restrict + - cascade + example: restrict + 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 + asyncExec: + name: asyncExec + in: query + description: Asynchronous execution enable/disable. Default is disable. + schema: + type: boolean + 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 + Link: + description: Links to the page of results (e.g. the first page, the last page, + etc.). The header can include multiple 'url' entries with different 'rel' + attribute values that specify the page to return ('first', 'next', 'prev', + and 'last'). + schema: + type: string + example: ; rel="first",; + rel="next",; + rel="last" + 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' + 408RequestTimeout: + description: Request Timeout. This indicates that the request from the client + timed out and was not completed by the server. + 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/releases/8.40/specifications/compute-pool.yaml b/releases/8.40/specifications/compute-pool.yaml new file mode 100644 index 0000000..79c3945 --- /dev/null +++ b/releases/8.40/specifications/compute-pool.yaml @@ -0,0 +1,498 @@ +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 + Link: + $ref: common.yaml#/components/headers/Link + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/compute-pools/{name}: + get: + summary: Fetches a compute pool. + tags: + - compute-pool + description: Fetches a named compute pool. You can get the name of the compute + pool from the `/api/v2/compute-pools` GET request. + operationId: fetchComputePool + parameters: + - $ref: common.yaml#/components/parameters/name + responses: + '200': + description: Successful request. + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + Link: + $ref: common.yaml#/components/headers/Link + content: + application/json: + schema: + $ref: '#/components/schemas/ComputePool' + '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) compute pool. + tags: + - compute-pool + description: Create a (or alter an existing) compute pool. Even if the operation + is just an alter, the full property set must be provided. + operationId: createOrAlterComputePool + parameters: + - $ref: common.yaml#/components/parameters/name + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ComputePool' + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + 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 + num_jobs: + type: integer + description: Number of jobs 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 + is_exclusive: + type: boolean + description: Whether a compute pool is created exclusively for a Snowflake + Native App. + readOnly: true + application: + type: string + description: Name of the Snowflake Native App if the compute pool is created + exclusively for the app. + readOnly: true + budget: + type: string + description: The name of the budget monitoring the credit usage 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 + num_jobs: 3 + auto_suspend_secs: 10 + active_nodes: 2 + idle_nodes: 2 + target_nodes: 4 + created_on: '2024-06-18T01:01:01.111111' + updated_on: '2024-06-18T01:01:01.111111' + resumed_on: '2024-06-18T01:01:01.111111' + owner: POOL_ADMIN + is_exclusive: true + application: testapp + budget: testbudget + 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 + securitySchemes: + KeyPair: + $ref: common.yaml#/components/securitySchemes/KeyPair + ExternalOAuth: + $ref: common.yaml#/components/securitySchemes/ExternalOAuth + SnowflakeOAuth: + $ref: common.yaml#/components/securitySchemes/SnowflakeOAuth +security: +- KeyPair: [] +- ExternalOAuth: [] +- SnowflakeOAuth: [] +tags: +- name: compute-pool diff --git a/releases/8.40/specifications/cortex-analyst.yaml b/releases/8.40/specifications/cortex-analyst.yaml new file mode 100644 index 0000000..2e0259b --- /dev/null +++ b/releases/8.40/specifications/cortex-analyst.yaml @@ -0,0 +1,266 @@ +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 + description: 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 + securitySchemes: + KeyPair: + $ref: common.yaml#/components/securitySchemes/KeyPair + ExternalOAuth: + $ref: common.yaml#/components/securitySchemes/ExternalOAuth + SnowflakeOAuth: + $ref: common.yaml#/components/securitySchemes/SnowflakeOAuth +security: +- KeyPair: [] +- ExternalOAuth: [] +- SnowflakeOAuth: [] diff --git a/releases/8.40/specifications/cortex-inference.yaml b/releases/8.40/specifications/cortex-inference.yaml new file mode 100644 index 0000000..d309b94 --- /dev/null +++ b/releases/8.40/specifications/cortex-inference.yaml @@ -0,0 +1,139 @@ +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: + 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 + 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_tokens: + description: The maximum number of output tokens to produce. The default + value is model-dependent. + type: integer + default: 4096 + minimum: 0 + guardrails: + $ref: '#/components/schemas/GuardrailsConfig' + required: + - model + - messages + GuardrailsConfig: + type: object + title: GuardrailsConfig + description: Guardrails configuration + nullable: true + properties: + enabled: + type: boolean + description: Controls whether guardrails are enabled + response_when_unsafe: + type: string + description: The response when the guardrails model marks the completion + as unsafe + example: Response filtered by Cortex Guard + 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. + securitySchemes: + KeyPair: + $ref: common.yaml#/components/securitySchemes/KeyPair + ExternalOAuth: + $ref: common.yaml#/components/securitySchemes/ExternalOAuth + SnowflakeOAuth: + $ref: common.yaml#/components/securitySchemes/SnowflakeOAuth +security: +- KeyPair: [] +- ExternalOAuth: [] +- SnowflakeOAuth: [] diff --git a/releases/8.40/specifications/cortex-search-service.yaml b/releases/8.40/specifications/cortex-search-service.yaml new file mode 100644 index 0000000..078479b --- /dev/null +++ b/releases/8.40/specifications/cortex-search-service.yaml @@ -0,0 +1,115 @@ +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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '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 + securitySchemes: + KeyPair: + $ref: common.yaml#/components/securitySchemes/KeyPair + ExternalOAuth: + $ref: common.yaml#/components/securitySchemes/ExternalOAuth + SnowflakeOAuth: + $ref: common.yaml#/components/securitySchemes/SnowflakeOAuth +security: +- KeyPair: [] +- ExternalOAuth: [] +- SnowflakeOAuth: [] diff --git a/releases/8.40/specifications/database-role.yaml b/releases/8.40/specifications/database-role.yaml new file mode 100644 index 0000000..521ce9e --- /dev/null +++ b/releases/8.40/specifications/database-role.yaml @@ -0,0 +1,616 @@ +openapi: 3.0.0 +servers: +- description: Snowflake REST Server + url: https://org-account.snowflakecomputing.com +info: + version: 0.0.1 + title: Snowflake Database Role API + description: The Snowflake Database Role API is a REST API that you can use to access, + update, and perform certain actions on Database Role resource in a Snowflake database. + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/databases/{database}/database-roles: + get: + summary: List database roles + tags: + - database-role + description: List database roles + operationId: listDatabaseRoles + parameters: + - $ref: common.yaml#/components/parameters/database + - $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 + Link: + $ref: common.yaml#/components/headers/Link + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/DatabaseRole' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + post: + summary: Create a database role + tags: + - database-role + description: Create a database role + operationId: createDatabaseRole + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/createMode + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DatabaseRole' + /api/v2/databases/{database}/database-roles/{name}: + delete: + summary: Delete a database role + tags: + - database-role + description: Delete a database role + operationId: deleteDatabaseRole + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/ifExists + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/database-roles/{name}:clone: + post: + summary: Create a new database role by cloning from the specified resource + tags: + - database-role + description: Create a new database role by cloning from the specified resource + operationId: cloneDatabaseRole + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/createMode + - name: targetDatabase + description: Database of the target resource. Defaults to the source's database + in: query + required: false + schema: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/DatabaseRoleClone' + /api/v2/databases/{database}/database-roles/{name}/grants: + get: + summary: List all grants to the role + tags: + - database-role + description: List all grants to the role + operationId: listGrants + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/showLimit + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + Link: + $ref: common.yaml#/components/headers/Link + content: + application/json: + schema: + type: array + items: + $ref: '#/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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + post: + summary: Grant privileges to the role + tags: + - database-role + description: Grant privileges to the role + operationId: grantPrivileges + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Grant' + /api/v2/databases/{database}/database-roles/{name}/grants:revoke: + post: + summary: Revoke grants from the role + tags: + - database-role + description: Revoke grants from the role + operationId: revokeGrants + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/mode + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Grant' + /api/v2/databases/{database}/database-roles/{name}/future-grants: + get: + summary: List all future grants to the role + tags: + - database-role + description: List all future grants to the role + operationId: listFutureGrants + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/showLimit + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + Link: + $ref: common.yaml#/components/headers/Link + content: + application/json: + schema: + type: array + items: + $ref: '#/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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + post: + summary: Grant future privileges to the role + tags: + - database-role + description: Grant future privileges to the role + operationId: grantFuturePrivileges + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Grant' + /api/v2/databases/{database}/database-roles/{name}/future-grants:revoke: + post: + summary: Revoke future grants from the role + tags: + - database-role + description: Revoke future grants from the role + operationId: revokeFutureGrants + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/mode + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Grant' +components: + schemas: + DatabaseRole: + type: object + description: A Snowflake database role + properties: + name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Name of the database role + comment: + type: string + description: User comment associated to an object in the dictionary + created_on: + type: string + format: date-time + readOnly: true + description: Date and time when the database role was created + granted_to_roles: + type: integer + format: int64 + readOnly: true + description: How many roles this database role has been granted to + granted_to_database_roles: + type: integer + format: int64 + readOnly: true + description: How many database roles this database role has been granted + to + granted_database_roles: + type: integer + format: int64 + readOnly: true + description: How many database roles this database role has been granted + owner: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + readOnly: true + description: Role that owns the database role + owner_role_type: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + readOnly: true + description: The type of role that owns the database role + required: + - name + DatabaseRoleClone: + type: object + properties: + name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Name of the database role + required: + - name + Grant: + type: object + properties: + securable: + $ref: '#/components/schemas/Securable' + description: Securable of the grant + containing_scope: + $ref: '#/components/schemas/ContainingScope' + description: Containing scope of the grant + securable_type: + type: string + description: Type of the securable to be granted. + grant_option: + type: boolean + description: If true, allows the recipient role to grant the privileges + to other roles. + privileges: + type: array + items: + type: string + description: List of privileges to be granted. + created_on: + type: string + format: date-time + readOnly: true + description: Date and time when the grant was created + granted_by: + type: string + readOnly: true + description: The role that granted this privilege to this grantee + required: + - securable_type + Securable: + type: object + properties: + database: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Database name of the securable if applicable. + schema: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Schema name of the securable if applicable. + service: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Service name of the securable if applicable. + name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Name of the securable if applicable. + required: + - name + ContainingScope: + type: object + properties: + database: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Database name of the securable scope if applicable. + schema: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Schema name of the securable scope if applicable. + required: + - database + securitySchemes: + KeyPair: + $ref: common.yaml#/components/securitySchemes/KeyPair + ExternalOAuth: + $ref: common.yaml#/components/securitySchemes/ExternalOAuth + SnowflakeOAuth: + $ref: common.yaml#/components/securitySchemes/SnowflakeOAuth +security: +- KeyPair: [] +- ExternalOAuth: [] +- SnowflakeOAuth: [] diff --git a/releases/8.40/specifications/database.yaml b/releases/8.40/specifications/database.yaml new file mode 100644 index 0000000..1bc0883 --- /dev/null +++ b/releases/8.40/specifications/database.yaml @@ -0,0 +1,872 @@ +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 + Link: + $ref: common.yaml#/components/headers/Link + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + Link: + $ref: common.yaml#/components/headers/Link + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{name}:undrop: + post: + summary: Undrop a database. + tags: + - database + description: Undrops database. + operationId: undropDatabase + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +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. + securitySchemes: + KeyPair: + $ref: common.yaml#/components/securitySchemes/KeyPair + ExternalOAuth: + $ref: common.yaml#/components/securitySchemes/ExternalOAuth + SnowflakeOAuth: + $ref: common.yaml#/components/securitySchemes/SnowflakeOAuth +security: +- KeyPair: [] +- ExternalOAuth: [] +- SnowflakeOAuth: [] diff --git a/releases/8.40/specifications/dynamic-table.yaml b/releases/8.40/specifications/dynamic-table.yaml new file mode 100644 index 0000000..9ce7e56 --- /dev/null +++ b/releases/8.40/specifications/dynamic-table.yaml @@ -0,0 +1,770 @@ +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 + Link: + $ref: common.yaml#/components/headers/Link + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + Link: + $ref: common.yaml#/components/headers/Link + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 name of the target dynamic table to be swapped with. + in: query + required: true + schema: + $ref: common.yaml#/components/schemas/Identifier + - name: targetDatabase + in: query + description: Database of the target dynamic table. Defaults to the source + table's database. + schema: + $ref: common.yaml#/components/schemas/Identifier + - name: targetSchema + in: query + description: Schema of the target dynamic table. Defaults to the source table's + schema. + schema: + $ref: common.yaml#/components/schemas/Identifier + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +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 + securitySchemes: + KeyPair: + $ref: common.yaml#/components/securitySchemes/KeyPair + ExternalOAuth: + $ref: common.yaml#/components/securitySchemes/ExternalOAuth + SnowflakeOAuth: + $ref: common.yaml#/components/securitySchemes/SnowflakeOAuth +security: +- KeyPair: [] +- ExternalOAuth: [] +- SnowflakeOAuth: [] diff --git a/releases/8.40/specifications/event-table.yaml b/releases/8.40/specifications/event-table.yaml new file mode 100644 index 0000000..8a0019b --- /dev/null +++ b/releases/8.40/specifications/event-table.yaml @@ -0,0 +1,385 @@ +openapi: 3.0.0 +servers: +- description: Snowflake REST Server + url: https://org-account.snowflakecomputing.com +info: + version: 0.0.1 + title: Snowflake Event Table API + description: The Snowflake Event Table API is a REST API that you can use to access, + update, and perform certain actions on Event Table resource in a Snowflake database. + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/databases/{database}/schemas/{schema}/event-tables: + get: + summary: List event tables + tags: + - event-table + description: List event tables + operationId: listEventTables + 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/EventTable' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + post: + summary: Create an event table + tags: + - event-table + description: Create an event table + operationId: createEventTable + 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 + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EventTable' + /api/v2/databases/{database}/schemas/{schema}/event-tables/{name}: + get: + summary: Fetch an event table + tags: + - event-table + description: Fetch an event table + operationId: fetchEventTable + 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/EventTable' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + delete: + summary: Delete an event table + tags: + - event-table + description: Delete an event table + operationId: deleteEventTable + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/event-tables/{name}:rename: + post: + summary: Rename the event table + tags: + - event-table + description: Rename the event table + operationId: renameEventTable + 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: Specify the name of the target resource to be renamed to. + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +components: + schemas: + EventTable: + type: object + description: A Snowflake event table + properties: + name: + type: string + description: Name of the event table + cluster_by: + type: array + items: + type: string + description: Cluster key column(s) or expression + data_retention_time_in_days: + type: integer + description: number of days to retain the old version of deleted/updated + data + max_data_extension_time_in_days: + type: integer + description: Maximum number of days to extend data retention beyond the + retention period to prevent a stream becoming stale. + change_tracking: + type: boolean + description: True if change tracking is enabled, allowing streams and CHANGES + to be used on the entity. + default_ddl_collation: + type: string + description: Collation that is used for all the new columns created by the + DDL statements (if not specified) + comment: + type: string + description: user comment associated to an object in the dictionary + created_on: + type: string + format: date-time + readOnly: true + description: Date and time when the event table was created. + database_name: + type: string + readOnly: true + description: Database in which the event table is stored + schema_name: + type: string + readOnly: true + description: Schema in which the event table is stored + owner: + type: string + readOnly: true + description: Role that owns the event table + owner_role_type: + type: string + readOnly: true + description: The type of role that owns the event table + rows: + type: integer + format: int64 + readOnly: true + description: Number of rows in the 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 + 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 + columns: + type: array + items: + $ref: '#/components/schemas/EventTableColumn' + readOnly: true + required: + - name + EventTableColumn: + type: object + properties: + name: + type: string + description: Column name + datatype: + type: string + description: The data type for the column + nullable: + type: boolean + description: Specifies that the column does allow NULL values or not + 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 + primary_key: + type: boolean + description: A primary key is the column or columns that contain values + that uniquely identify each row in a table + unique_key: + type: boolean + 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. + check: + type: string + description: '' + expression: + type: string + description: '' + comment: + type: string + description: Specifies a comment for the column + securitySchemes: + KeyPair: + $ref: common.yaml#/components/securitySchemes/KeyPair + ExternalOAuth: + $ref: common.yaml#/components/securitySchemes/ExternalOAuth + SnowflakeOAuth: + $ref: common.yaml#/components/securitySchemes/SnowflakeOAuth +security: +- KeyPair: [] +- ExternalOAuth: [] +- SnowflakeOAuth: [] diff --git a/releases/8.40/specifications/external-volume.yaml b/releases/8.40/specifications/external-volume.yaml new file mode 100644 index 0000000..c3b7422 --- /dev/null +++ b/releases/8.40/specifications/external-volume.yaml @@ -0,0 +1,400 @@ +openapi: 3.0.0 +servers: +- description: Snowflake REST Server + url: https://org-account.snowflakecomputing.com +info: + version: 0.0.1 + title: Snowflake External Volume API + description: The Snowflake External Volume API is a REST API that you can use to + access, update, and perform certain actions on External Volume resource in a Snowflake + database. + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/external-volumes: + get: + summary: List external volumes + tags: + - external-volume + description: List external volumes + operationId: listExternalVolumes + 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 + Link: + $ref: common.yaml#/components/headers/Link + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ExternalVolume' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + post: + summary: Create an external volume + tags: + - external-volume + description: Create an external volume + operationId: createExternalVolume + parameters: + - $ref: common.yaml#/components/parameters/createMode + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalVolume' + /api/v2/external-volumes/{name}: + get: + summary: Fetch an external volume + tags: + - external-volume + description: Fetch an external volume + operationId: fetchExternalVolume + 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 + Link: + $ref: common.yaml#/components/headers/Link + content: + application/json: + schema: + $ref: '#/components/schemas/ExternalVolume' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + delete: + summary: Delete an external volume + tags: + - external-volume + description: Delete an external volume + operationId: deleteExternalVolume + parameters: + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/ifExists + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/external-volumes/{name}:undrop: + post: + summary: Undrop an external volume + tags: + - external-volume + description: Undrop an external volume + operationId: undropExternalVolume + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +components: + schemas: + ExternalVolume: + type: object + description: A Snowflake external volume + properties: + name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: String that specifies the identifier (the name) for the external + volume; must be unique in your account. + storage_locations: + type: array + items: + $ref: '#/components/schemas/StorageLocation' + description: Set of named cloud storage locations in different regions and, + optionally, cloud platforms. + allow_writes: + type: boolean + description: Specifies whether write operations are allowed for the external + volume; must be set to TRUE for Iceberg tables that use Snowflake as the + catalog. + comment: + type: string + description: String (literal) that specifies a comment for the external + volume. + created_on: + type: string + format: date-time + readOnly: true + description: Date and time when the external volume was created. + owner: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + readOnly: true + description: Role that owns the external volume + owner_role_type: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + readOnly: true + description: The type of role that owns the external volume + required: + - name + - storage_locations + StorageLocation: + type: object + properties: + name: + type: string + description: '' + storage_provider: + type: string + enum: + - S3 + - S3GOV + - GCS + - AZURE + description: Specifies the cloud storage provider that stores your data + files. + required: + - name + - storage_provider + discriminator: + propertyName: storage_provider + mapping: + S3: StorageLocationS3 + S3GOV: StorageLocationS3Gov + GCS: StorageLocationGcs + AZURE: StorageLocationAzure + StorageLocationS3: + allOf: + - $ref: '#/components/schemas/StorageLocation' + properties: + storage_aws_role_arn: + type: string + description: Specifies the case-sensitive Amazon Resource Name (ARN) of + the AWS identity and access management (IAM) role that grants privileges + on the S3 bucket containing your data files. + storage_base_url: + type: string + description: Specifies the base URL for your cloud storage location. + storage_aws_external_id: + type: string + description: Optionally specifies an external ID that Snowflake uses to + establish a trust relationship with AWS. + encryption: + $ref: '#/components/schemas/Encryption' + description: Specifies the properties needed to encrypt data on the external + volume. + required: + - storage_aws_role_arn + - storage_base_url + Encryption: + type: object + properties: + type: + type: string + enum: + - NONE + - AWS_SSE_S3 + - AWS_SSE_KMS + - GCS_SSE_KMS + description: Specifies the encryption type used. + kms_key_id: + type: string + description: Specifies the ID for the Cloud KMS-managed key used to encrypt + files written to the bucket. + required: + - type + StorageLocationS3Gov: + allOf: + - $ref: '#/components/schemas/StorageLocation' + properties: + storage_aws_role_arn: + type: string + description: Specifies the case-sensitive Amazon Resource Name (ARN) of + the AWS identity and access management (IAM) role that grants privileges + on the S3 bucket containing your data files. + storage_base_url: + type: string + description: Specifies the base URL for your cloud storage location. + storage_aws_external_id: + type: string + description: Optionally specifies an external ID that Snowflake uses to + establish a trust relationship with AWS. + encryption: + $ref: '#/components/schemas/Encryption' + description: Specifies the properties needed to encrypt data on the external + volume. + required: + - storage_aws_role_arn + - storage_base_url + StorageLocationGcs: + allOf: + - $ref: '#/components/schemas/StorageLocation' + properties: + storage_base_url: + type: string + description: Specifies the base URL for your cloud storage location. + encryption: + $ref: '#/components/schemas/Encryption' + description: Specifies the properties needed to encrypt data on the external + volume. + required: + - storage_base_url + StorageLocationAzure: + allOf: + - $ref: '#/components/schemas/StorageLocation' + properties: + azure_tenant_id: + type: string + description: Specifies the ID for your Office 365 tenant that the allowed + and blocked storage accounts belong to. + storage_base_url: + type: string + description: Specifies the base URL for your cloud storage location. + required: + - azure_tenant_id + - storage_base_url + securitySchemes: + KeyPair: + $ref: common.yaml#/components/securitySchemes/KeyPair + ExternalOAuth: + $ref: common.yaml#/components/securitySchemes/ExternalOAuth + SnowflakeOAuth: + $ref: common.yaml#/components/securitySchemes/SnowflakeOAuth +security: +- KeyPair: [] +- ExternalOAuth: [] +- SnowflakeOAuth: [] diff --git a/releases/8.40/specifications/function.yaml b/releases/8.40/specifications/function.yaml new file mode 100644 index 0000000..85aa651 --- /dev/null +++ b/releases/8.40/specifications/function.yaml @@ -0,0 +1,345 @@ +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 + Link: + $ref: common.yaml#/components/headers/Link + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + Link: + $ref: common.yaml#/components/headers/Link + 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 + service_database: + $ref: ./common.yaml#/components/schemas/Identifier + description: Service's database name + service_schema: + $ref: ./common.yaml#/components/schemas/Identifier + description: Service's schema name + endpoint: + type: string + description: Function's endpoint + path: + type: string + description: Function's path + securitySchemes: + KeyPair: + $ref: common.yaml#/components/securitySchemes/KeyPair + ExternalOAuth: + $ref: common.yaml#/components/securitySchemes/ExternalOAuth + SnowflakeOAuth: + $ref: common.yaml#/components/securitySchemes/SnowflakeOAuth +security: +- KeyPair: [] +- ExternalOAuth: [] +- SnowflakeOAuth: [] diff --git a/releases/8.40/specifications/grant.yaml b/releases/8.40/specifications/grant.yaml new file mode 100644 index 0000000..fac7249 --- /dev/null +++ b/releases/8.40/specifications/grant.yaml @@ -0,0 +1,513 @@ +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 + deprecated: true + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + deprecated: true + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + deprecated: true + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + deprecated: true + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + deprecated: true + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + deprecated: true + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + deprecated: true + 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 + Link: + $ref: common.yaml#/components/headers/Link + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +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 + securitySchemes: + KeyPair: + $ref: common.yaml#/components/securitySchemes/KeyPair + ExternalOAuth: + $ref: common.yaml#/components/securitySchemes/ExternalOAuth + SnowflakeOAuth: + $ref: common.yaml#/components/securitySchemes/SnowflakeOAuth +security: +- KeyPair: [] +- ExternalOAuth: [] +- SnowflakeOAuth: [] diff --git a/releases/8.40/specifications/image-repository.yaml b/releases/8.40/specifications/image-repository.yaml new file mode 100644 index 0000000..ea219af --- /dev/null +++ b/releases/8.40/specifications/image-repository.yaml @@ -0,0 +1,310 @@ +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 + Link: + $ref: common.yaml#/components/headers/Link + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + Link: + $ref: common.yaml#/components/headers/Link + 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 + Link: + $ref: common.yaml#/components/headers/Link + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Image' + '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: + Image: + type: object + description: A image in a Snowflake image repository. + properties: + created_on: + type: string + description: Date and time when the image was uploaded to the image repository. + readOnly: true + image_name: + type: string + description: Image name. + readOnly: true + tags: + type: string + description: Image tags. + readOnly: true + digest: + type: string + description: SHA256 digest of the image. + readOnly: true + image_path: + type: string + description: Image path (database_name/schema_name/repository_name/image_name:image_tag). + readOnly: true + 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 + securitySchemes: + KeyPair: + $ref: common.yaml#/components/securitySchemes/KeyPair + ExternalOAuth: + $ref: common.yaml#/components/securitySchemes/ExternalOAuth + SnowflakeOAuth: + $ref: common.yaml#/components/securitySchemes/SnowflakeOAuth +security: +- KeyPair: [] +- ExternalOAuth: [] +- SnowflakeOAuth: [] diff --git a/releases/8.40/specifications/network-policy.yaml b/releases/8.40/specifications/network-policy.yaml new file mode 100644 index 0000000..accb1ff --- /dev/null +++ b/releases/8.40/specifications/network-policy.yaml @@ -0,0 +1,237 @@ +openapi: 3.0.0 +servers: +- description: Snowflake REST Server + url: https://org-account.snowflakecomputing.com +info: + version: 0.0.1 + title: Snowflake Network Policy API + description: The Snowflake Network Policy API is a REST API that you can use to + access, update, and perform certain actions on Network Policy resource in a Snowflake + database. + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/network-policies: + get: + summary: List network policies + tags: + - network-policy + description: List network policies + operationId: listNetworkPolicies + parameters: [] + 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/NetworkPolicy' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + post: + summary: Create a network policy + tags: + - network-policy + description: Create a network policy + operationId: createNetworkPolicy + parameters: + - $ref: common.yaml#/components/parameters/createMode + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NetworkPolicy' + /api/v2/network-policies/{name}: + get: + summary: Fetch a network policy + tags: + - network-policy + description: Fetch a network policy + operationId: fetchNetworkPolicy + 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/NetworkPolicy' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + delete: + summary: Delete a network policy + tags: + - network-policy + description: Delete a network policy + operationId: deleteNetworkPolicy + parameters: + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/ifExists + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +components: + schemas: + NetworkPolicy: + type: object + description: A Snowflake network policy + properties: + name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Name of the network policy + allowed_network_rule_list: + type: array + items: + type: string + description: List of names of allowed network rules in a network policy + blocked_network_rule_list: + type: array + items: + type: string + description: List of names of blocked network rules in a network policy + allowed_ip_list: + type: array + items: + type: string + description: List of allowed IPs in a network policy + blocked_ip_list: + type: array + items: + type: string + description: List of blocked IPs in a network policy + comment: + type: string + description: user comment associated to an object in the dictionary + created_on: + type: string + format: date-time + readOnly: true + description: Date and time when the network policy was created. + owner: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + readOnly: true + description: Role that owns the network policy + owner_role_type: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + readOnly: true + description: The type of role that owns the network policy + required: + - name diff --git a/releases/8.40/specifications/notebook.yaml b/releases/8.40/specifications/notebook.yaml new file mode 100644 index 0000000..50a212c --- /dev/null +++ b/releases/8.40/specifications/notebook.yaml @@ -0,0 +1,566 @@ +openapi: 3.0.0 +servers: +- description: Snowflake REST Server + url: https://org-account.snowflakecomputing.com +info: + version: 0.0.1 + title: Snowflake Notebook API + description: The Snowflake Notebook API is a REST API that you can use to access, + update, and perform certain actions on Notebook resource in a Snowflake database. + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/databases/{database}/schemas/{schema}/notebooks: + get: + summary: List notebooks + tags: + - notebook + description: List notebooks + operationId: listNotebooks + 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 + Link: + $ref: common.yaml#/components/headers/Link + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Notebook' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + post: + summary: Create a notebook + tags: + - notebook + description: Create a notebook + operationId: createNotebook + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/createMode + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Notebook' + /api/v2/databases/{database}/schemas/{schema}/notebooks/{name}: + get: + summary: Fetch a notebook + tags: + - notebook + description: Fetch a notebook + operationId: fetchNotebook + 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 + Link: + $ref: common.yaml#/components/headers/Link + content: + application/json: + schema: + $ref: '#/components/schemas/Notebook' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + delete: + summary: Delete a notebook + tags: + - notebook + description: Delete a notebook + operationId: deleteNotebook + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:execute: + post: + summary: Execute a Notebook + tags: + - notebook + description: Execute a Notebook + operationId: executeNotebook + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/asyncExec + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:rename: + post: + summary: Changes the name of the notebook to new name. The new identifier must + be unique for the schema. + tags: + - notebook + description: Changes the name of the notebook to new name. The new identifier + must be unique for the schema. + operationId: renameNotebook + 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: targetDatabase + description: Database of the target resource. Defaults to the source's database + in: query + required: true + schema: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + - name: targetSchema + description: Schema of the target resource. Defaults to the source's schema + in: query + required: true + schema: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + - name: targetName + description: Name of the target resource. + in: query + required: true + schema: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:add-live-version: + post: + summary: Adds a LIVE version to the notebook + tags: + - notebook + description: Adds a LIVE version to the notebook + operationId: addLiveVersionNotebook + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - name: fromLast + description: Sets the LIVE version to the LAST version of the notebook + in: query + required: false + schema: + type: boolean + - name: comment + description: Sets a comment for the notebook or version of the notebook + in: query + required: false + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:commit: + post: + summary: If a Git connection is set up for the notebook, commits the LIVE version + of the notebook to the Git repository + tags: + - notebook + description: If a Git connection is set up for the notebook, commits the LIVE + version of the notebook to the Git repository + operationId: commitNotebook + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/name + - name: version + description: live version of the alias + in: query + required: false + schema: + type: string + - name: comment + description: Sets a comment for the notebook or version of the notebook + in: query + required: false + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +components: + schemas: + Notebook: + type: object + description: A Snowflake notebook + properties: + name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Name of the notebook + version: + type: string + description: User specified version alias + fromLocation: + type: string + description: Location to copy the file from. This must be a Snowflake stage + location. + main_file: + type: string + description: Name + path of the file for the Notebook + comment: + type: string + description: user comment associated to an object in the dictionary + default_version: + type: string + description: The default version name of a file based entity. + query_warehouse: + type: string + description: Warehouse against which the queries issued by the Streamlit + app are run against + created_on: + type: string + format: date-time + readOnly: true + description: Date and time when the notebook was created. + database_name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + readOnly: true + description: Database in which the notebook is stored + schema_name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + readOnly: true + description: Schema in which the notebook is stored + owner: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + readOnly: true + description: Role that owns the notebook + owner_role_type: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + readOnly: true + description: The type of role that owns the notebook + url_id: + type: string + readOnly: true + description: Unique ID associated with the notebook object. + title: + type: string + readOnly: true + description: User facing title of the Streamlit app or an Organization Profile + default_packages: + type: string + readOnly: true + description: Default packages of the notebook + user_packages: + type: string + readOnly: true + description: User packages of the notebook + runtime_name: + type: string + readOnly: true + description: The runtime to run the Streamlit or Notebook on. If this is + not set, the warehouse is assumed + compute_pool: + type: string + readOnly: true + description: Compute pool name where the snowservice runs + import_urls: + type: array + items: + type: string + readOnly: true + description: List of urls + external_access_integrations: + type: array + items: + type: string + readOnly: true + description: List of external access integrations attached to this function + external_access_secrets: + type: string + readOnly: true + description: Secrets to be used with this function for external access + idle_auto_shutdown_time_seconds: + type: integer + format: int64 + readOnly: true + description: Sets the time in seconds for when to shutdown an idle Notebook. + default_version_details: + $ref: '#/components/schemas/VersionDetails' + readOnly: true + last_version_details: + $ref: '#/components/schemas/VersionDetails' + readOnly: true + live_version_location_uri: + type: string + readOnly: true + description: The current version location + budget: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + readOnly: true + description: Name of the budget if the notebook is monitored by a budget + required: + - name + VersionDetails: + type: object + description: The version details of a file based entity + properties: + name: + type: string + readOnly: true + description: The last version name + alias: + type: string + readOnly: true + description: The default/last version alias of a file based entity. + location_url: + type: string + readOnly: true + description: The default/last version location. + source_location_uri: + type: string + readOnly: true + description: The default/last version source location. + git_commit_hash: + type: string + readOnly: true + description: The default/last version git commit# + securitySchemes: + KeyPair: + $ref: common.yaml#/components/securitySchemes/KeyPair + ExternalOAuth: + $ref: common.yaml#/components/securitySchemes/ExternalOAuth + SnowflakeOAuth: + $ref: common.yaml#/components/securitySchemes/SnowflakeOAuth +security: +- KeyPair: [] +- ExternalOAuth: [] +- SnowflakeOAuth: [] diff --git a/releases/8.40/specifications/notification-integration.yaml b/releases/8.40/specifications/notification-integration.yaml new file mode 100644 index 0000000..d640e34 --- /dev/null +++ b/releases/8.40/specifications/notification-integration.yaml @@ -0,0 +1,399 @@ +openapi: 3.0.0 +servers: +- description: Snowflake REST Server + url: https://org-account.snowflakecomputing.com +info: + version: 0.0.1 + title: Snowflake Notification Integration API + description: The Snowflake Notification Integration API is a REST API that you can + use to access, update, and perform certain actions on Notification Integration + resource in a Snowflake database. + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/notification-integrations: + get: + summary: List notification integrations + tags: + - notification-integration + description: List notification integrations + operationId: listNotificationIntegrations + 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 + Link: + $ref: common.yaml#/components/headers/Link + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/NotificationIntegration' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + post: + summary: Create a notification integration + tags: + - notification-integration + description: Create a notification integration + operationId: createNotificationIntegration + parameters: + - $ref: common.yaml#/components/parameters/createMode + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationIntegration' + /api/v2/notification-integrations/{name}: + get: + summary: Fetch a notification integration + tags: + - notification-integration + description: Fetch a notification integration + operationId: fetchNotificationIntegration + 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 + Link: + $ref: common.yaml#/components/headers/Link + content: + application/json: + schema: + $ref: '#/components/schemas/NotificationIntegration' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + delete: + summary: Delete a notification integration + tags: + - notification-integration + description: Delete a notification integration + operationId: deleteNotificationIntegration + parameters: + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/ifExists + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +components: + schemas: + NotificationIntegration: + type: object + description: A Snowflake notification + properties: + name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Name of the notification. + enabled: + type: boolean + description: Whether the notification integration is enabled. + comment: + type: string + description: Comment for the notification integration. + created_on: + type: string + format: date-time + readOnly: true + description: Date and time when the notification was created. + notification_hook: + $ref: '#/components/schemas/NotificationHook' + required: + - name + - notification_hook + NotificationHook: + type: object + properties: + type: + type: string + enum: + - EMAIL + - WEBHOOK + - QUEUE_AWS_SNS_OUTBOUND + - QUEUE_AZURE_EVENT_GRID_OUTBOUND + - QUEUE_GCP_PUBSUB_OUTBOUND + - QUEUE_AZURE_EVENT_GRID_INBOUND + - QUEUE_GCP_PUBSUB_INBOUND + description: Type of NotificationHook, can be QUEUE, EMAIL or WEBHOOK + required: + - type + discriminator: + propertyName: type + mapping: + EMAIL: NotificationEmail + WEBHOOK: NotificationWebhook + QUEUE_AWS_SNS_OUTBOUND: NotificationQueueAwsSnsOutbound + QUEUE_AZURE_EVENT_GRID_OUTBOUND: NotificationQueueAzureEventGridOutbound + QUEUE_GCP_PUBSUB_OUTBOUND: NotificationQueueGcpPubsubOutbound + QUEUE_AZURE_EVENT_GRID_INBOUND: NotificationQueueAzureEventGridInbound + QUEUE_GCP_PUBSUB_INBOUND: NotificationQueueGcpPubsubInbound + NotificationEmail: + allOf: + - $ref: '#/components/schemas/NotificationHook' + properties: + allowed_recipients: + type: array + items: + type: string + description: A comma-separated list of quoted email addresses that can receive + notification emails from this integration. + default_recipients: + type: array + items: + type: string + description: A comma-separated list of default recipients for messages sent + with this integration. + default_subject: + type: string + description: the default subject line for messages sent with this integration. + NotificationWebhook: + allOf: + - $ref: '#/components/schemas/NotificationHook' + properties: + webhook_url: + type: string + description: The URL for the webhook. The URL must use the https:// protocol. + webhook_secret: + $ref: '#/components/schemas/WebhookSecret' + description: The secret to use with this integration. + webhook_body_template: + type: string + description: A template for the body of the HTTP request to send for the + notification. + webhook_headers: + type: object + additionalProperties: + type: string + description: A list of HTTP headers and values to include in the HTTP request + for the webhook. + required: + - webhook_url + WebhookSecret: + type: object + properties: + name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: The name of the secret. + database_name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: The database which stores the secret. + schema_name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: The schema which stores the secret. + required: + - name + - database_name + - schema_name + NotificationQueueAwsSnsOutbound: + allOf: + - $ref: '#/components/schemas/NotificationHook' + properties: + aws_sns_topic_arn: + type: string + description: Amazon Resource Name (ARN) of the Amazon SNS (SNS) topic to + which notifications are pushed. + aws_sns_role_arn: + type: string + description: ARN of the IAM role that has permissions to publish messages + to the SNS topic. + sf_aws_iam_user_arn: + type: string + readOnly: true + description: ARN for the Snowflake IAM user created for your account. + sf_aws_external_id: + type: string + readOnly: true + description: External ID for the Snowflake IAM user created for your account. + NotificationQueueAzureEventGridOutbound: + allOf: + - $ref: '#/components/schemas/NotificationHook' + properties: + azure_event_grid_topic_endpoint: + type: string + description: Event Grid topic endpoint to which Snowpipe pushes notifications. + azure_tenant_id: + type: string + description: ID of the Azure Active Directory tenant used for identity management. + azure_consent_url: + type: string + readOnly: true + description: URL to the Microsoft permissions request page. + azure_multi_tenant_app_name: + type: string + readOnly: true + description: Name of the Snowflake client application created for your account. + NotificationQueueGcpPubsubOutbound: + allOf: + - $ref: '#/components/schemas/NotificationHook' + properties: + gcp_pubsub_topic_name: + type: string + description: Identification of the Pub/Sub topic to which Snowpipe pushes + notifications. + gcp_pubsub_service_account: + type: string + readOnly: true + description: Google Cloud Platform (GCP) service account created for your + account. + NotificationQueueAzureEventGridInbound: + allOf: + - $ref: '#/components/schemas/NotificationHook' + properties: + azure_storage_queue_primary_uri: + type: string + description: the queue ID for the Azure Queue Storage queue created for + Event Grid notifications. + azure_tenant_id: + type: string + description: the ID of the Azure Active Directory tenant used for identity + management. + azure_consent_url: + type: string + readOnly: true + description: URL to the Microsoft permissions request page. + azure_multi_tenant_app_name: + type: string + readOnly: true + description: Name of the Snowflake client application created for your account. + NotificationQueueGcpPubsubInbound: + allOf: + - $ref: '#/components/schemas/NotificationHook' + properties: + gcp_pubsub_subscription_name: + type: string + description: Pub/Sub topic subscription ID used to allow Snowflake access + to event messages. + gcp_pubsub_service_account: + type: string + readOnly: true + description: Google Cloud Platform (GCP) service account created for your + account. + securitySchemes: + KeyPair: + $ref: common.yaml#/components/securitySchemes/KeyPair + ExternalOAuth: + $ref: common.yaml#/components/securitySchemes/ExternalOAuth + SnowflakeOAuth: + $ref: common.yaml#/components/securitySchemes/SnowflakeOAuth +security: +- KeyPair: [] +- ExternalOAuth: [] +- SnowflakeOAuth: [] diff --git a/releases/8.40/specifications/pipe.yaml b/releases/8.40/specifications/pipe.yaml new file mode 100644 index 0000000..dfae68e --- /dev/null +++ b/releases/8.40/specifications/pipe.yaml @@ -0,0 +1,337 @@ +openapi: 3.0.0 +servers: +- description: Snowflake REST Server + url: https://org-account.snowflakecomputing.com +info: + version: 0.0.1 + title: Snowflake Pipe API + description: The Snowflake Pipe API is a REST API that you can use to access, update, + and perform certain actions on Pipe resource in a Snowflake database. + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/databases/{database}/schemas/{schema}/pipes: + get: + summary: List pipes + tags: + - pipe + description: List pipes + operationId: listPipes + 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/Pipe' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + post: + summary: Create a pipe + tags: + - pipe + description: Create a pipe + operationId: createPipe + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: common.yaml#/components/parameters/createMode + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Pipe' + /api/v2/databases/{database}/schemas/{schema}/pipes/{name}: + get: + summary: Fetch a pipe + tags: + - pipe + description: Fetch a pipe + operationId: fetchPipe + 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/Pipe' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + delete: + summary: Delete a pipe + tags: + - pipe + description: Delete a pipe + operationId: deletePipe + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/pipes/{name}:refresh: + post: + summary: Refresh the pipe + tags: + - pipe + description: Refresh the pipe + operationId: refreshPipe + 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: prefix + description: Path (or prefix) appended to the stage reference in the pipe + definition. The path limits the set of files to load. + in: query + required: false + schema: + type: string + - name: modified_after + description: Timestamp (in ISO-8601 format) of the oldest data files to copy + into the Snowpipe ingest queue based on the LAST_MODIFIED date (i.e. date + when a file was staged) + in: query + required: false + schema: + type: string + format: date-time + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +components: + schemas: + Pipe: + type: object + description: A Snowflake pipe + properties: + name: + type: string + description: Name of the pipe + comment: + type: string + description: user comment associated to an object in the dictionary + auto_ingest: + type: boolean + description: TRUE if all files from stage need to be auto-ingested + error_integration: + type: string + description: Link to integration object that point to a user provided Azure + storage queue / SQS. When present, errors (e.g. ingest failure for Snowpipe + or a user task failure or replication failure) will be sent to this queue + to notify customers + aws_sns_topic: + type: string + description: Optional, if provided, auto_ingest pipe will only receive messages + from this SNS topic. + integration: + type: string + description: Link to integration object that ties a user provided storage + queue to an auto_ingest enabled pipe. Required for auto_ingest to work + on azure. + copy_statement: + type: string + description: COPY INTO statement used to load data from queued files + into a Snowflake table. This statement serves as the text/definition for + the pipe and is displayed in the SHOW PIPES output + pattern: (?i)^COPY INTO .* + created_on: + type: string + format: date-time + readOnly: true + description: Date and time when the pipe was created. + database_name: + type: string + readOnly: true + description: Database in which the pipe is stored + schema_name: + type: string + readOnly: true + description: Schema in which the pipe is stored + owner: + type: string + readOnly: true + description: Role that owns the pipe + pattern: + type: string + readOnly: true + description: PATTERN copy option value in the COPY INTO
statement + in the pipe definition, if the copy option was specified. + owner_role_type: + type: string + readOnly: true + description: The type of role that owns the pipe + invalid_reason: + type: string + readOnly: true + description: Displays some detailed information for your pipes that may + have issues + budget: + type: string + readOnly: true + description: Name of the budget if the pipe is monitored by a budget + required: + - name + - copy_statement + securitySchemes: + KeyPair: + $ref: common.yaml#/components/securitySchemes/KeyPair + ExternalOAuth: + $ref: common.yaml#/components/securitySchemes/ExternalOAuth + SnowflakeOAuth: + $ref: common.yaml#/components/securitySchemes/SnowflakeOAuth +security: +- KeyPair: [] +- ExternalOAuth: [] +- SnowflakeOAuth: [] diff --git a/releases/8.40/specifications/procedure.yaml b/releases/8.40/specifications/procedure.yaml new file mode 100644 index 0000000..b0b2143 --- /dev/null +++ b/releases/8.40/specifications/procedure.yaml @@ -0,0 +1,815 @@ +openapi: 3.0.0 +servers: +- description: Snowflake REST Server + url: https://org-account.snowflakecomputing.com +info: + version: 0.0.1 + title: Snowflake Procedure API + description: The Snowflake Procedure API is a REST API that you can use to access, + update, and perform certain actions on Procedure resource in a Snowflake database. + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/databases/{database}/schemas/{schema}/procedures: + get: + summary: List procedures + tags: + - procedure + description: List procedures + operationId: listProcedures + 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 + Link: + $ref: common.yaml#/components/headers/Link + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Procedure' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + post: + summary: Create a procedure + tags: + - procedure + description: Create a procedure + operationId: createProcedure + 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 + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Procedure' + /api/v2/databases/{database}/schemas/{schema}/procedures/{nameWithArgs}: + get: + summary: Fetch a procedure + tags: + - procedure + description: Fetch a procedure + operationId: fetchProcedure + 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 + Link: + $ref: common.yaml#/components/headers/Link + content: + application/json: + schema: + $ref: '#/components/schemas/Procedure' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + delete: + summary: Delete a procedure + tags: + - procedure + description: Delete a procedure + operationId: deleteProcedure + 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 + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/procedures/{nameWithArgs}:call: + post: + summary: Call a procedure + tags: + - procedure + description: Call a procedure + operationId: callProcedure + 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 + Link: + $ref: common.yaml#/components/headers/Link + content: + application/json: + schema: + type: array + items: {} + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/CallArgumentList' +components: + schemas: + Procedure: + type: object + description: A Snowflake procedure + properties: + name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Name of the procedure + execute_as: + type: string + enum: + - CALLER + - OWNER + description: What permissions should the procedure execution be called with + is_secure: + type: boolean + description: Specifies whether the function/procedure is secure or not + arguments: + type: array + items: + $ref: '#/components/schemas/Argument' + description: List of arguments for the function/procedure + return_type: + $ref: '#/components/schemas/ReturnType' + description: Return type of the function/procedure. Should be a SQL data + type or a table + language_config: + $ref: '#/components/schemas/FunctionLanguage' + description: Language that the function/procedure is written in + comment: + type: string + description: Specifies a comment for the function/procedure + body: + type: string + description: Function/procedure definition + created_on: + type: string + format: date-time + readOnly: true + description: The date and time when the function/procedure was created + schema_name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + readOnly: true + description: The name of the schema in which the function/procedure exists. + database_name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + readOnly: true + description: The name of the database in which the function/procedure exists. + min_num_arguments: + type: integer + readOnly: true + description: The minimum number of arguments + max_num_arguments: + type: integer + readOnly: true + description: The maximum number of arguments + owner: + type: string + readOnly: true + description: Role that owns the function/procedure + owner_role_type: + type: string + readOnly: true + description: The type of role that owns the function/procedure + is_builtin: + type: boolean + readOnly: true + description: If the function/procedure is built-in or not (user-defined) + required: + - name + - arguments + - return_type + - language_config + - body + Argument: + type: object + properties: + name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Argument name + datatype: + type: string + enum: + - ARRAY + - BIGINT + - BINARY + - BOOLEAN + - BYTEINT + - CHAR + - CHARACTER + - DATE + - DATETIME + - DECIMAL + - DOUBLE + - DOUBLE PRECISION + - FLOAT + - FLOAT4 + - FLOAT8 + - GEOGRAPHY + - GEOMETRY + - INT + - INTEGER + - NUMBER + - NUMERIC + - OBJECT + - REAL + - STRING + - SMALLINT + - TEXT + - TIME + - TIMESTAMP_LTZ + - TIMESTAMP_NTZ + - TIMESTAMP_TZ + - TINYINT + - VARBINARY + - VARCHAR + - VARIANT + - VECTOR + x-enum-varnames: + - ARRAY + - BIGINT + - BINARY + - BOOLEAN + - BYTEINT + - CHAR + - CHARACTER + - DATE + - DATETIME + - DECIMAL + - DOUBLE + - DOUBLE_PRECISION + - FLOAT + - FLOAT4 + - FLOAT8 + - GEOGRAPHY + - GEOMETRY + - INT + - INTEGER + - NUMBER + - NUMERIC + - OBJECT + - REAL + - STRING + - SMALLINT + - TEXT + - TIME + - TIMESTAMP_LTZ + - TIMESTAMP_NTZ + - TIMESTAMP_TZ + - TINYINT + - VARBINARY + - VARCHAR + - VARIANT + - VECTOR + description: Argument data type + default_value: + type: string + description: Default value of the argument + required: + - name + - datatype + ReturnType: + type: object + properties: + type: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Type of the return, can be either DATATYPE or TABLE + required: + - type + discriminator: + propertyName: type + mapping: + DATATYPE: ReturnDataType + TABLE: ReturnTable + ReturnDataType: + allOf: + - $ref: '#/components/schemas/ReturnType' + properties: + datatype: + type: string + enum: + - ARRAY + - BIGINT + - BINARY + - BOOLEAN + - BYTEINT + - CHAR + - CHARACTER + - DATE + - DATETIME + - DECIMAL + - DOUBLE + - DOUBLE PRECISION + - FLOAT + - FLOAT4 + - FLOAT8 + - GEOGRAPHY + - GEOMETRY + - INT + - INTEGER + - NUMBER + - NUMERIC + - OBJECT + - REAL + - STRING + - SMALLINT + - TEXT + - TIME + - TIMESTAMP_LTZ + - TIMESTAMP_NTZ + - TIMESTAMP_TZ + - TINYINT + - VARBINARY + - VARCHAR + - VARIANT + - VECTOR + x-enum-varnames: + - ARRAY + - BIGINT + - BINARY + - BOOLEAN + - BYTEINT + - CHAR + - CHARACTER + - DATE + - DATETIME + - DECIMAL + - DOUBLE + - DOUBLE_PRECISION + - FLOAT + - FLOAT4 + - FLOAT8 + - GEOGRAPHY + - GEOMETRY + - INT + - INTEGER + - NUMBER + - NUMERIC + - OBJECT + - REAL + - STRING + - SMALLINT + - TEXT + - TIME + - TIMESTAMP_LTZ + - TIMESTAMP_NTZ + - TIMESTAMP_TZ + - TINYINT + - VARBINARY + - VARCHAR + - VARIANT + - VECTOR + description: Return data type + nullable: + type: boolean + description: Argument null return acceptance criteria + required: + - datatype + ReturnTable: + allOf: + - $ref: '#/components/schemas/ReturnType' + properties: + column_list: + type: array + items: + $ref: '#/components/schemas/ColumnType' + description: List of table columns to return + ColumnType: + type: object + properties: + name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Argument name + datatype: + type: string + enum: + - ARRAY + - BIGINT + - BINARY + - BOOLEAN + - BYTEINT + - CHAR + - CHARACTER + - DATE + - DATETIME + - DECIMAL + - DOUBLE + - DOUBLE PRECISION + - FLOAT + - FLOAT4 + - FLOAT8 + - GEOGRAPHY + - GEOMETRY + - INT + - INTEGER + - NUMBER + - NUMERIC + - OBJECT + - REAL + - STRING + - SMALLINT + - TEXT + - TIME + - TIMESTAMP_LTZ + - TIMESTAMP_NTZ + - TIMESTAMP_TZ + - TINYINT + - VARBINARY + - VARCHAR + - VARIANT + - VECTOR + x-enum-varnames: + - ARRAY + - BIGINT + - BINARY + - BOOLEAN + - BYTEINT + - CHAR + - CHARACTER + - DATE + - DATETIME + - DECIMAL + - DOUBLE + - DOUBLE_PRECISION + - FLOAT + - FLOAT4 + - FLOAT8 + - GEOGRAPHY + - GEOMETRY + - INT + - INTEGER + - NUMBER + - NUMERIC + - OBJECT + - REAL + - STRING + - SMALLINT + - TEXT + - TIME + - TIMESTAMP_LTZ + - TIMESTAMP_NTZ + - TIMESTAMP_TZ + - TINYINT + - VARBINARY + - VARCHAR + - VARIANT + - VECTOR + description: Argument data type + required: + - name + - datatype + FunctionLanguage: + type: object + properties: + language: + type: string + description: 'Language that the function/procedure is written in. Possible + values include: JAVA, JAVASCRIPT, PYTHON, SCALA, SQL' + called_on_null_input: + type: boolean + description: Decide if the function/procedure can receive null input + required: + - language + discriminator: + propertyName: language + mapping: + JAVA: JavaFunction + PYTHON: PythonFunction + SCALA: ScalaFunction + JAVASCRIPT: JavaScriptFunction + SQL: SQLFunction + BaseLanguage: + allOf: + - $ref: '#/components/schemas/FunctionLanguage' + properties: + runtime_version: + type: string + description: Runtime version of the function's/procedure's specified language + packages: + type: array + items: + type: string + description: Packages to include with the function/procedure + imports: + type: array + items: + type: string + description: List of imports + handler: + type: string + description: Fully qualified method name including the package and the class + required: + - runtime_version + - packages + - handler + JavaFunction: + allOf: + - $ref: '#/components/schemas/BaseLanguage' + properties: + external_access_integrations: + type: array + items: + type: string + description: List of external access integrations attached to this function/procedure + secrets: + type: object + additionalProperties: + type: string + description: Secrets to be used with this function/procedure for external + access + target_path: + type: string + description: Specifies where Snowflake should write the compiled code for + inline procedures + PythonFunction: + allOf: + - $ref: '#/components/schemas/BaseLanguage' + properties: + external_access_integrations: + type: array + items: + type: string + description: List of external access integrations attached to this function/procedure + secrets: + type: object + additionalProperties: + type: string + description: Secrets to be used with this function/procedure for external + access + ScalaFunction: + allOf: + - $ref: '#/components/schemas/BaseLanguage' + properties: + target_path: + type: string + description: Specifies where Snowflake should write the compiled code for + inline function/procedures + JavaScriptFunction: + allOf: + - $ref: '#/components/schemas/FunctionLanguage' + SQLFunction: + allOf: + - $ref: '#/components/schemas/FunctionLanguage' + CallArgumentList: + type: object + properties: + call_arguments: + type: array + items: + $ref: '#/components/schemas/CallArgument' + description: Call Argument list + required: + - call_arguments + CallArgument: + type: object + properties: + name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Name of the call argument + datatype: + type: string + enum: + - ARRAY + - BIGINT + - BINARY + - BOOLEAN + - BYTEINT + - CHAR + - CHARACTER + - DATE + - DATETIME + - DECIMAL + - DOUBLE + - DOUBLE PRECISION + - FLOAT + - FLOAT4 + - FLOAT8 + - GEOGRAPHY + - GEOMETRY + - INT + - INTEGER + - NUMBER + - NUMERIC + - OBJECT + - REAL + - STRING + - SMALLINT + - TEXT + - TIME + - TIMESTAMP_LTZ + - TIMESTAMP_NTZ + - TIMESTAMP_TZ + - TINYINT + - VARBINARY + - VARCHAR + - VARIANT + - VECTOR + x-enum-varnames: + - ARRAY + - BIGINT + - BINARY + - BOOLEAN + - BYTEINT + - CHAR + - CHARACTER + - DATE + - DATETIME + - DECIMAL + - DOUBLE + - DOUBLE_PRECISION + - FLOAT + - FLOAT4 + - FLOAT8 + - GEOGRAPHY + - GEOMETRY + - INT + - INTEGER + - NUMBER + - NUMERIC + - OBJECT + - REAL + - STRING + - SMALLINT + - TEXT + - TIME + - TIMESTAMP_LTZ + - TIMESTAMP_NTZ + - TIMESTAMP_TZ + - TINYINT + - VARBINARY + - VARCHAR + - VARIANT + - VECTOR + description: Call argument data type + value: + description: Value of the call argument + required: + - name + - datatype + - value + securitySchemes: + KeyPair: + $ref: common.yaml#/components/securitySchemes/KeyPair + ExternalOAuth: + $ref: common.yaml#/components/securitySchemes/ExternalOAuth + SnowflakeOAuth: + $ref: common.yaml#/components/securitySchemes/SnowflakeOAuth +security: +- KeyPair: [] +- ExternalOAuth: [] +- SnowflakeOAuth: [] diff --git a/releases/8.40/specifications/result.yaml b/releases/8.40/specifications/result.yaml new file mode 100644 index 0000000..af07bd4 --- /dev/null +++ b/releases/8.40/specifications/result.yaml @@ -0,0 +1,82 @@ +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 + Link: + $ref: common.yaml#/components/headers/Link + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '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: + securitySchemes: + KeyPair: + $ref: common.yaml#/components/securitySchemes/KeyPair + ExternalOAuth: + $ref: common.yaml#/components/securitySchemes/ExternalOAuth + SnowflakeOAuth: + $ref: common.yaml#/components/securitySchemes/SnowflakeOAuth +security: +- KeyPair: [] +- ExternalOAuth: [] +- SnowflakeOAuth: [] diff --git a/releases/8.40/specifications/role.yaml b/releases/8.40/specifications/role.yaml new file mode 100644 index 0000000..8b9f906 --- /dev/null +++ b/releases/8.40/specifications/role.yaml @@ -0,0 +1,721 @@ +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 actions on Role resource in a Snowflake database. + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/roles: + get: + summary: List roles + tags: + - role + description: List roles + 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 + Link: + $ref: common.yaml#/components/headers/Link + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + post: + summary: Create a role + tags: + - role + description: Create a role + operationId: createRole + parameters: + - $ref: common.yaml#/components/parameters/createMode + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Role' + /api/v2/roles/{name}: + delete: + summary: Delete a role + tags: + - role + description: Delete a role + operationId: deleteRole + parameters: + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/ifExists + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/roles/{name}/grants: + get: + summary: List all grants to the role + tags: + - role + description: List all grants to the role + operationId: listGrants + parameters: + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/showLimit + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + Link: + $ref: common.yaml#/components/headers/Link + content: + application/json: + schema: + type: array + items: + $ref: '#/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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + post: + summary: Grant privileges to the role + tags: + - role + description: Grant privileges to the role + operationId: grantPrivileges + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Grant' + /api/v2/roles/{name}/grants:revoke: + post: + summary: Revoke grants from the role + tags: + - role + description: Revoke grants from the role + operationId: revokeGrants + parameters: + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/mode + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Grant' + /api/v2/roles/{name}/grants-of: + get: + summary: List all grants of the role + tags: + - role + description: List all grants of the role + operationId: listGrantsOf + parameters: + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/showLimit + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + Link: + $ref: common.yaml#/components/headers/Link + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/GrantOf' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/roles/{name}/grants-on: + get: + summary: List all grants on the role + tags: + - role + description: List all grants on the role + operationId: listGrantsOn + parameters: + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/showLimit + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + Link: + $ref: common.yaml#/components/headers/Link + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/GrantOn' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/roles/{name}/future-grants: + get: + summary: List all future grants to the role + tags: + - role + description: List all future grants to the role + operationId: listFutureGrants + parameters: + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/showLimit + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + Link: + $ref: common.yaml#/components/headers/Link + content: + application/json: + schema: + type: array + items: + $ref: '#/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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + post: + summary: Grant future privileges to the role + tags: + - role + description: Grant future privileges to the role + operationId: grantFuturePrivileges + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Grant' + /api/v2/roles/{name}/future-grants:revoke: + post: + summary: Revoke future grants from the role + tags: + - role + description: Revoke future grants from the role + operationId: revokeFutureGrants + parameters: + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/mode + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Grant' +components: + schemas: + Role: + type: object + description: A Snowflake role + properties: + name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Name of the role. + comment: + type: string + description: Comment of the role. + created_on: + type: string + format: date-time + readOnly: true + description: Date and time when the role was created. + owner: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + readOnly: true + description: Specifies the role that owns this role. + is_default: + type: boolean + readOnly: true + description: Specifies whether the role being fetched is the user's default + role. + is_current: + type: boolean + readOnly: true + description: Specifies whether the role being fetched is the user's current + role. + is_inherited: + type: boolean + readOnly: true + description: Specifies whether the role used to run the command inherits + the specified role. + assigned_to_users: + type: integer + format: int64 + readOnly: true + description: The number of users to whom this role has been assigned. + granted_to_roles: + type: integer + format: int64 + readOnly: true + description: The number of roles to which this role has been granted. + granted_roles: + type: integer + format: int64 + readOnly: true + description: The number of roles that have been granted to this role. + required: + - name + Grant: + type: object + properties: + securable: + $ref: '#/components/schemas/Securable' + description: Securable of the grant + containing_scope: + $ref: '#/components/schemas/ContainingScope' + description: Containing scope of the grant + securable_type: + type: string + description: Type of the securable to be granted. + grant_option: + type: boolean + description: If true, allows the recipient role to grant the privileges + to other roles. + privileges: + type: array + items: + type: string + description: List of privileges to be granted. + created_on: + type: string + format: date-time + readOnly: true + description: Date and time when the grant was created + granted_by: + type: string + readOnly: true + description: The role that granted this privilege to this grantee + required: + - securable_type + Securable: + type: object + properties: + database: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Database name of the securable if applicable. + schema: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Schema name of the securable if applicable. + service: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Service name of the securable if applicable. + name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Name of the securable if applicable. + required: + - name + ContainingScope: + type: object + properties: + database: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Database name of the securable scope if applicable. + schema: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Schema name of the securable scope if applicable. + required: + - database + GrantOf: + type: object + properties: + created_on: + type: string + format: date-time + readOnly: true + description: Date and time when the grant was created + role: + type: string + readOnly: true + description: The name of the role + granted_to: + type: string + readOnly: true + description: The type of the grantee, can be USER or ROLE + grantee_name: + type: string + readOnly: true + description: The name of the grantee + granted_by: + type: string + readOnly: true + description: The role that granted this role to this grantee + GrantOn: + type: object + properties: + created_on: + type: string + format: date-time + readOnly: true + description: Date and time when the grant was created + privilege: + type: string + readOnly: true + description: The name of the privilege + granted_on: + type: string + readOnly: true + description: The type of of the role + name: + type: string + readOnly: true + description: The name of the role + granted_to: + type: string + readOnly: true + description: The type of the grantee + grantee_name: + type: string + readOnly: true + description: The name of the grantee + grant_option: + type: string + readOnly: true + description: If true, allows the recipient role to grant the privileges + to other roles. + granted_by: + type: string + readOnly: true + description: The role that granted this privilege to this grantee + granted_by_role_type: + type: string + readOnly: true + description: Type of the role that granted this privilege to this grantee + securitySchemes: + KeyPair: + $ref: common.yaml#/components/securitySchemes/KeyPair + ExternalOAuth: + $ref: common.yaml#/components/securitySchemes/ExternalOAuth + SnowflakeOAuth: + $ref: common.yaml#/components/securitySchemes/SnowflakeOAuth +security: +- KeyPair: [] +- ExternalOAuth: [] +- SnowflakeOAuth: [] diff --git a/releases/8.40/specifications/schema.yaml b/releases/8.40/specifications/schema.yaml new file mode 100644 index 0000000..be9524a --- /dev/null +++ b/releases/8.40/specifications/schema.yaml @@ -0,0 +1,513 @@ +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 + Link: + $ref: common.yaml#/components/headers/Link + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + Link: + $ref: common.yaml#/components/headers/Link + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +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 + securitySchemes: + KeyPair: + $ref: common.yaml#/components/securitySchemes/KeyPair + ExternalOAuth: + $ref: common.yaml#/components/securitySchemes/ExternalOAuth + SnowflakeOAuth: + $ref: common.yaml#/components/securitySchemes/SnowflakeOAuth +security: +- KeyPair: [] +- ExternalOAuth: [] +- SnowflakeOAuth: [] diff --git a/releases/8.40/specifications/service.yaml b/releases/8.40/specifications/service.yaml new file mode 100644 index 0000000..d580a63 --- /dev/null +++ b/releases/8.40/specifications/service.yaml @@ -0,0 +1,1165 @@ +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 + Link: + $ref: common.yaml#/components/headers/Link + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/services:execute-job: + post: + summary: Execute a job service + tags: + - service + description: Create and execute a job service. See the JobService component + definition for what is required to be provided in the request body. + operationId: executeJobService + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/JobService' + 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 + Link: + $ref: common.yaml#/components/headers/Link + 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 + put: + summary: Create a (or alter an existing) service. + tags: + - service + description: Create a (or alter an existing) service. Even if the operation + is just an alter, the full property set must be provided. + operationId: createOrAlterService + 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/Service' + responses: + '200': + description: Successful request + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + Link: + $ref: common.yaml#/components/headers/Link + content: + application/json: + schema: + $ref: common.yaml#/components/schemas/SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + 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 + Link: + $ref: common.yaml#/components/headers/Link + 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 + Link: + $ref: common.yaml#/components/headers/Link + 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}/containers: + get: + description: List all the containers of the service + tags: + - service + operationId: listServiceContainers + 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 + Link: + $ref: common.yaml#/components/headers/Link + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ServiceContainer' + '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}/instances: + get: + description: List all the instances of the service + tags: + - service + operationId: listServiceInstances + 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 + Link: + $ref: common.yaml#/components/headers/Link + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ServiceInstance' + '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}/roles: + get: + description: List all the service roles of the service + tags: + - service + operationId: listServiceRoles + 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 + Link: + $ref: common.yaml#/components/headers/Link + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ServiceRole' + '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/{service}/roles/{name}/grants-of: + get: + description: List all the grants of the service role + tags: + - service + operationId: listServiceRoleGrantsOf + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: '#/components/parameters/service' + - $ref: common.yaml#/components/parameters/name + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + Link: + $ref: common.yaml#/components/headers/Link + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/GrantOf' + '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/{service}/roles/{name}/grants: + get: + description: List all the grants given to the service role + tags: + - service + operationId: listServiceRoleGrantsTo + parameters: + - $ref: common.yaml#/components/parameters/database + - $ref: common.yaml#/components/parameters/schema + - $ref: '#/components/parameters/service' + - $ref: common.yaml#/components/parameters/name + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + Link: + $ref: common.yaml#/components/headers/Link + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ServiceRoleGrantTo' + '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 + Link: + $ref: common.yaml#/components/headers/Link + 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: + parameters: + service: + name: service + description: Name of the service that contains the service role. + required: true + in: path + schema: + $ref: ./common.yaml#/components/schemas/Identifier + 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: + allOf: + - $ref: '#/components/schemas/JobService' + - type: object + description: A Snowflake service object. + properties: + auto_resume: + type: boolean + description: Specifies whether to automatically resume a service when + a service function or ingress is called. + current_instances: + type: integer + description: The current number of instances for the service. + readOnly: true + target_instances: + type: integer + description: The target number of service instances that should be running + as determined by Snowflake. + readOnly: true + min_ready_instances: + type: integer + description: The minimum number of ready service instances to declare + the service as READY. + readOnly: true + 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. + 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 + is_job: + type: boolean + description: True if the service is a job service; false otherwise. + readOnly: true + spec_digest: + type: string + description: The unique and immutable identifier representing the service + spec content. + readOnly: true + is_upgrading: + type: boolean + description: TRUE, if Snowflake is in the process of upgrading the service. + readOnly: true + managing_object_domain: + type: string + description: The domain of the managing object (for example, the domain + of the notebook that manages the service). NULL if the service is not + managed by a Snowflake entity. + readOnly: true + managing_object_name: + type: string + description: The name of the managing object (for example, the name of + the notebook that manages the service). NULL if the service is not managed + by a Snowflake entity. + readOnly: true + example: + min_instances: 2 + max_instances: 5 + database_name: testdb + schema_name: testschema + owner: SYSADMIN + is_job: false + JobService: + type: object + description: A Snowflake job service object. + writeOnly: true + properties: + name: + $ref: ./common.yaml#/components/schemas/Identifier + description: String that specifies the identifier (that is, the name) for + the service. + status: + type: string + description: The current status of 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 + 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. + 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 + description: User-friendly endpoint name that represents the corresponding + port. + port: + type: integer + description: The network port the service is listening on. NULL, when portRange + is specified. + portRange: + type: string + description: The network port range the service is listening on. NULL, when + port is specified. + protocol: + type: string + description: Supported network protocol (TCP, HTTP, or HTTPS). + default: HTTP + is_public: + type: boolean + description: True, if the endpoint is public, accessible from internet. + default: false + ingress_url: + type: string + description: Endpoint URL accessible from the internet. + readOnly: true + example: + name: endpoint + port: 8080 + protocol: HTTPS + is_public: true + ingress_url: abcd-org-acc.snowflakecomputing.app + ServiceContainer: + type: object + properties: + database_name: + $ref: ./common.yaml#/components/schemas/Identifier + description: Database in which the service is created. + readOnly: true + schema_name: + $ref: ./common.yaml#/components/schemas/Identifier + description: Schema in which the service is created. + readOnly: true + service_name: + $ref: ./common.yaml#/components/schemas/Identifier + description: The name of the service. + readOnly: true + instance_id: + type: string + description: ID of the service instance (this is the index of the service + instance starting from 0). + readOnly: true + container_name: + type: string + description: Name of the container. + readOnly: true + status: + type: string + description: Service container status. + readOnly: true + message: + type: string + description: Additional clarification about status. + readOnly: true + image_name: + type: string + description: Image name used to create the service container. + readOnly: true + image_digest: + type: string + description: The unique and immutable identifier representing the image + content. + readOnly: true + restart_count: + type: integer + description: Number of times Snowflake restarted the service. + readOnly: true + start_time: + type: string + description: Date and time when the container started. + readOnly: true + example: + database_name: testdb + schema_name: testschema + service_name: myservice + instance_id: '0' + container_name: main + status: PENDING + message: Pending scheduling. + image_name: /db/schema/repo/image:1.0 + image_digest: abcdefd + restart_count: 0 + start_time: 2023-01-01 00:00:00+00:00 + ServiceInstance: + type: object + properties: + database_name: + $ref: ./common.yaml#/components/schemas/Identifier + description: Database in which the service is created. + readOnly: true + schema_name: + $ref: ./common.yaml#/components/schemas/Identifier + description: Schema in which the service is created. + readOnly: true + service_name: + $ref: ./common.yaml#/components/schemas/Identifier + description: The name of the service. + readOnly: true + instance_id: + type: string + description: ID of the service instance (this is the index of the service + instance starting from 0). + readOnly: true + status: + type: string + description: The current status of the service instance. + readOnly: true + spec_digest: + type: string + description: The unique and immutable identifier that represents the service + specification content. + readOnly: true + creation_time: + type: string + description: The time when Snowflake started creating the service instance. + readOnly: true + start_time: + type: string + description: The time when Snowflake acknowledged the service instance is + running on a node. + readOnly: true + example: + database_name: testdb + schema_name: testschema + service_name: myservice + instance_id: '0' + status: PENDING + spec_digest: abcdefg + creation_time: 2023-01-01 00:00:00+00:00 + start_time: 2023-01-01 00:00:00+00:00 + ServiceRole: + type: object + properties: + created_on: + type: string + format: date-time + description: Date and time when the service role was created + readOnly: true + name: + type: string + description: Service role name + readOnly: true + comment: + type: string + description: Comment, if any, for the service role + readOnly: true + example: + created_on: 2023-01-01 00:00:00+00:00 + name: testrole + comment: This is a service role. + GrantOf: + type: object + properties: + created_on: + type: string + format: date-time + readOnly: true + description: Date and time when the grant was created + role: + type: string + readOnly: true + description: The name of the service role + granted_to: + type: string + readOnly: true + description: The type of the grantee, can be USER or ROLE + grantee_name: + type: string + readOnly: true + description: The name of the grantee + granted_by: + type: string + readOnly: true + description: The name of role that granted the service role to the grantee + example: + created_on: 2023-01-01 00:00:00+00:00 + role: db.schema.service.svc_role + granted_to: role + grantee_name: test_role + granted_by: sysadmin + ServiceRoleGrantTo: + type: object + properties: + created_on: + type: string + format: date-time + readOnly: true + description: Date and time when the grant was created + privilege: + type: string + readOnly: true + description: The name of the privilege + granted_on: + type: string + readOnly: true + description: The type of of the securable + name: + type: string + readOnly: true + description: The name of the securable + granted_to: + type: string + readOnly: true + description: The type of the grantee + grantee_name: + type: string + readOnly: true + description: The name of the grantee + example: + created_on: 2023-01-01 00:00:00+00:00 + privilege: usage + granted_on: service_endpoint + name: db.schema.service!svc_role + granted_to: service role + grantee_name: all_endpoints_usage + securitySchemes: + KeyPair: + $ref: common.yaml#/components/securitySchemes/KeyPair + ExternalOAuth: + $ref: common.yaml#/components/securitySchemes/ExternalOAuth + SnowflakeOAuth: + $ref: common.yaml#/components/securitySchemes/SnowflakeOAuth +security: +- KeyPair: [] +- ExternalOAuth: [] +- SnowflakeOAuth: [] diff --git a/releases/8.40/specifications/stage.yaml b/releases/8.40/specifications/stage.yaml new file mode 100644 index 0000000..0b08823 --- /dev/null +++ b/releases/8.40/specifications/stage.yaml @@ -0,0 +1,514 @@ +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 + Link: + $ref: common.yaml#/components/headers/Link + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + Link: + $ref: common.yaml#/components/headers/Link + 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 + Link: + $ref: common.yaml#/components/headers/Link + 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, only works for Server Side + Encrypted Stages. + 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 + format: password + 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 + format: password + description: Scoped credentials generated by AWS Security Token Service + (STS). + aws_secret_key: + type: string + format: password + description: Scoped credentials generated by AWS Security Token Service + (STS). + aws_token: + type: string + format: password + 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 + format: password + description: Specifies the SAS (shared access signature) token for connecting + to Azure. + securitySchemes: + KeyPair: + $ref: common.yaml#/components/securitySchemes/KeyPair + ExternalOAuth: + $ref: common.yaml#/components/securitySchemes/ExternalOAuth + SnowflakeOAuth: + $ref: common.yaml#/components/securitySchemes/SnowflakeOAuth +security: +- KeyPair: [] +- ExternalOAuth: [] +- SnowflakeOAuth: [] diff --git a/releases/8.40/specifications/stream.yaml b/releases/8.40/specifications/stream.yaml new file mode 100644 index 0000000..5c53169 --- /dev/null +++ b/releases/8.40/specifications/stream.yaml @@ -0,0 +1,495 @@ +openapi: 3.0.0 +servers: +- description: Snowflake REST Server + url: https://org-account.snowflakecomputing.com +info: + version: 0.0.1 + title: Snowflake Stream API + description: The Snowflake Stream API is a REST API that you can use to access, + update, and perform certain actions on Stream resource in a Snowflake database. + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/databases/{database}/schemas/{schema}/streams: + get: + summary: List streams + tags: + - stream + description: List streams + operationId: listStreams + 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/Stream' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + post: + summary: Create a stream + tags: + - stream + description: Create a stream + operationId: createStream + 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 + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Stream' + /api/v2/databases/{database}/schemas/{schema}/streams/{name}: + get: + summary: Fetch a stream + tags: + - stream + description: Fetch a stream + operationId: fetchStream + 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/Stream' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + delete: + summary: Delete a stream + tags: + - stream + description: Delete a stream + operationId: deleteStream + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/streams/{name}:clone: + post: + summary: Clone a stream + tags: + - stream + description: Clone a stream + operationId: cloneStream + 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 + - name: targetDatabase + description: Database of the target resource. Defaults to the source's database + in: query + required: true + schema: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + - name: targetSchema + description: Schema of the target resource. Defaults to the source's schema + in: query + required: true + schema: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + - $ref: common.yaml#/components/parameters/copyGrants + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/StreamClone' +components: + schemas: + Stream: + type: object + description: A Snowflake stream + properties: + created_on: + type: string + format: date-time + readOnly: true + description: Date and time when the stream was created. + name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Name of the stream + stream_source: + $ref: '#/components/schemas/StreamSource' + description: Source for the stream + comment: + type: string + description: user comment associated to an object in the dictionary + database_name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + readOnly: true + description: Database in which the stream is stored + schema_name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + readOnly: true + description: Schema in which the stream is stored + owner: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + readOnly: true + description: Role that owns the stream + table_name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + readOnly: true + description: Table name whose changes are tracked by the stream + stale: + type: boolean + readOnly: true + description: Specifies whether the stream is stale or not + mode: + type: string + readOnly: true + description: 'Mode of the stream. Possible values include: APPEND_ONLY, + INSERT_ONLY. For streams on tables, the column displays DEFAULT.' + stale_after: + type: string + format: date-time + readOnly: true + description: 'Timestamp when the stream became stale or may become stale + if not consumed. ' + invalid_reason: + type: string + readOnly: true + description: Reason why the stream cannot be queried successfully. This + column supports future functionality. Currently, the only value returned + is N/A. + owner_role_type: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + readOnly: true + description: The type of role that owns the stream + type: + type: string + readOnly: true + description: Type of the stream; currently DELTA only. + required: + - name + - stream_source + StreamSource: + type: object + properties: + src_type: + type: string + description: 'Type of the source. Possible values include: stream, table, + view' + name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Name of the source whose changes are tracked by the stream + database_name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Database name to which stream source type belongs. If not provided, + database name provided in the path param will be used. + schema_name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Schema name to which stream source type belongs. If not provided, + schema name provided in the path param will be used. + required: + - src_type + - name + discriminator: + propertyName: src_type + mapping: + table: StreamSourceTable + external_table: StreamSourceExternalTable + view: StreamSourceView + stage: StreamSourceStage + StreamSourceTable: + type: object + allOf: + - $ref: '#/components/schemas/StreamSource' + properties: + append_only: + type: boolean + description: Whether this stream is an append only stream or not + show_initial_rows: + type: boolean + description: Whether this stream show initial rows on first consumption + point_of_time: + $ref: '#/components/schemas/PointOfTime' + description: Point of time for the stream + PointOfTime: + type: object + properties: + point_of_time_type: + type: string + description: 'Type of the point of time. Possible values include: timestamp, + offset, statement' + reference: + type: string + enum: + - at + - before + x-enum-varnames: + - AT + - BEFORE + description: Relation to the point of time. Currently, the API supports + `at` and `before` + required: + - point_of_time_type + - reference + discriminator: + propertyName: point_of_time_type + mapping: + timestamp: PointOfTimeTimestamp + offset: PointOfTimeOffset + statement: PointOfTimeStatement + stream: PointOfTimeStream + PointOfTimeTimestamp: + type: object + allOf: + - $ref: '#/components/schemas/PointOfTime' + properties: + timestamp: + type: string + description: Timestamp of the point of time. + required: + - timestamp + PointOfTimeOffset: + type: object + allOf: + - $ref: '#/components/schemas/PointOfTime' + properties: + offset: + type: string + description: Point of time identified by an offset in reference to the current + time, such as `10 min`. + required: + - offset + PointOfTimeStatement: + type: object + allOf: + - $ref: '#/components/schemas/PointOfTime' + properties: + statement: + type: string + description: Statement of the point of time. + required: + - statement + PointOfTimeStream: + type: object + allOf: + - $ref: '#/components/schemas/PointOfTime' + properties: + stream: + type: string + description: 'Creates the new stream at the same offset as the specified + stream. ' + StreamSourceExternalTable: + type: object + allOf: + - $ref: '#/components/schemas/StreamSource' + properties: + insert_only: + type: boolean + description: Whether this stream is an insert only stream or not + point_of_time: + $ref: '#/components/schemas/PointOfTime' + description: Point of time for the stream + StreamSourceView: + type: object + allOf: + - $ref: '#/components/schemas/StreamSource' + properties: + append_only: + type: boolean + description: Whether this stream is an append only stream or not + show_initial_rows: + type: boolean + description: Whether this stream show initial rows on first consumption + point_of_time: + $ref: '#/components/schemas/PointOfTime' + description: Point of time for the stream + base_tables: + type: array + items: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + readOnly: true + description: List of base tables for the stream + StreamSourceStage: + type: object + allOf: + - $ref: '#/components/schemas/StreamSource' + StreamClone: + type: object + properties: + name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Name of the stream + comment: + type: string + description: user comment associated to an object in the dictionary + required: + - name diff --git a/releases/8.40/specifications/table.yaml b/releases/8.40/specifications/table.yaml new file mode 100644 index 0000000..3f46900 --- /dev/null +++ b/releases/8.40/specifications/table.yaml @@ -0,0 +1,1231 @@ +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 + Link: + $ref: common.yaml#/components/headers/Link + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + Link: + $ref: common.yaml#/components/headers/Link + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 name of the target table to be swapped with. + in: query + required: true + schema: + $ref: common.yaml#/components/schemas/Identifier + - name: targetDatabase + in: query + description: Database of the target table. Defaults to the source table's + database. + schema: + $ref: common.yaml#/components/schemas/Identifier + - name: targetSchema + in: query + description: Schema of the target table. Defaults to the source table's schema. + schema: + $ref: common.yaml#/components/schemas/Identifier + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +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 + table_type: + type: string + enum: + - NORMAL + - DYNAMIC + - EXTERNAL + - EVENT + - HYBRID + - ICEBERG + - IMMUTABLE + readOnly: true + description: Type of the table + 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 + securitySchemes: + KeyPair: + $ref: common.yaml#/components/securitySchemes/KeyPair + ExternalOAuth: + $ref: common.yaml#/components/securitySchemes/ExternalOAuth + SnowflakeOAuth: + $ref: common.yaml#/components/securitySchemes/SnowflakeOAuth +security: +- KeyPair: [] +- ExternalOAuth: [] +- SnowflakeOAuth: [] diff --git a/releases/8.40/specifications/task.yaml b/releases/8.40/specifications/task.yaml new file mode 100644 index 0000000..93d458b --- /dev/null +++ b/releases/8.40/specifications/task.yaml @@ -0,0 +1,934 @@ +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 + Link: + $ref: common.yaml#/components/headers/Link + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + Link: + $ref: common.yaml#/components/headers/Link + 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 + - $ref: common.yaml#/components/parameters/asyncExec + - 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 + Link: + $ref: common.yaml#/components/headers/Link + 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 + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + Link: + $ref: common.yaml#/components/headers/Link + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/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 + Link: + $ref: common.yaml#/components/headers/Link + 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 + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + Link: + $ref: common.yaml#/components/headers/Link + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/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 + Link: + $ref: common.yaml#/components/headers/Link + 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 + securitySchemes: + KeyPair: + $ref: common.yaml#/components/securitySchemes/KeyPair + ExternalOAuth: + $ref: common.yaml#/components/securitySchemes/ExternalOAuth + SnowflakeOAuth: + $ref: common.yaml#/components/securitySchemes/SnowflakeOAuth +security: +- KeyPair: [] +- ExternalOAuth: [] +- SnowflakeOAuth: [] +externalDocs: + description: Streams and Tasks Reference + url: https://docs.snowflake.com/en/sql-reference/commands-stream diff --git a/releases/8.40/specifications/user-defined-function.yaml b/releases/8.40/specifications/user-defined-function.yaml new file mode 100644 index 0000000..10a80cd --- /dev/null +++ b/releases/8.40/specifications/user-defined-function.yaml @@ -0,0 +1,766 @@ +openapi: 3.0.0 +servers: +- description: Snowflake REST Server + url: https://org-account.snowflakecomputing.com +info: + version: 0.0.1 + title: Snowflake User Defined Function API + description: The Snowflake User Defined Function API is a REST API that you can + use to access, update, and perform certain actions on User Defined Function resource + in a Snowflake database. + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/databases/{database}/schemas/{schema}/user-defined-functions: + post: + summary: Create a UDF + tags: + - user-defined-function + description: Create a UDF + operationId: createUserDefinedFunction + 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 + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/UserDefinedFunction' + get: + summary: List UDFs + tags: + - user-defined-function + description: List UDFs + operationId: listUserDefinedFunctions + 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 + Link: + $ref: common.yaml#/components/headers/Link + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/UserDefinedFunction' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/user-defined-functions/{nameWithArgs}: + get: + summary: Fetch a UDF + tags: + - user-defined-function + description: Fetch a UDF + operationId: fetchUserDefinedFunction + 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 + Link: + $ref: common.yaml#/components/headers/Link + content: + application/json: + schema: + $ref: '#/components/schemas/UserDefinedFunction' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + delete: + summary: Delete a UDF + tags: + - user-defined-function + description: Delete a UDF + operationId: deleteUserDefinedFunction + 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 + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/databases/{database}/schemas/{schema}/user-defined-functions/{nameWithArgs}:rename: + post: + summary: Rename a UDF + tags: + - user-defined-function + description: Rename a UDF + operationId: renameUserDefinedFunction + 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 + - name: targetDatabase + description: Database of the target resource. Defaults to the source's database + in: query + required: true + schema: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + - name: targetSchema + description: Schema of the target resource. Defaults to the source's schema + in: query + required: true + schema: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + - name: targetName + description: Name of the target resource. + in: query + required: true + schema: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +components: + schemas: + UserDefinedFunction: + type: object + description: A snowflake UDF + properties: + name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: The name of the UDF + is_temporary: + type: boolean + description: Specifies whether the UDF is temporary or not + is_aggregate: + type: boolean + description: Specifies whether the UDF is an aggregate function. Applicable + only for Python language type + is_memoizable: + type: boolean + description: Indicates whether the function is memoizable. Applicable only + for Python language type. + is_table_function: + type: boolean + readOnly: true + description: True if the UDF is a table function; false otherwise. + valid_for_clustering: + type: boolean + readOnly: true + description: True if the UDF is valid for clustering; false otherwise. + is_secure: + type: boolean + description: Specifies whether the function/procedure is secure or not + arguments: + type: array + items: + $ref: '#/components/schemas/Argument' + description: List of arguments for the function/procedure + return_type: + $ref: '#/components/schemas/ReturnType' + description: Return type of the function/procedure. Should be a SQL data + type or a table + language_config: + $ref: '#/components/schemas/FunctionLanguage' + description: Language that the function/procedure is written in + comment: + type: string + description: Specifies a comment for the function/procedure + body: + type: string + description: Function/procedure definition + created_on: + type: string + format: date-time + readOnly: true + description: The date and time when the function/procedure was created + schema_name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + readOnly: true + description: The name of the schema in which the function/procedure exists. + database_name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + readOnly: true + description: The name of the database in which the function/procedure exists. + min_num_arguments: + type: integer + readOnly: true + description: The minimum number of arguments + max_num_arguments: + type: integer + readOnly: true + description: The maximum number of arguments + owner: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + readOnly: true + description: Role that owns the function/procedure + owner_role_type: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + readOnly: true + description: The type of role that owns the function/procedure + is_builtin: + type: boolean + readOnly: true + description: If the function/procedure is built-in or not (user-defined) + required: + - name + - arguments + - return_type + - language_config + Argument: + type: object + properties: + name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Argument name + datatype: + type: string + enum: + - ARRAY + - BIGINT + - BINARY + - BOOLEAN + - BYTEINT + - CHAR + - CHARACTER + - DATE + - DATETIME + - DECIMAL + - DOUBLE + - DOUBLE PRECISION + - FLOAT + - FLOAT4 + - FLOAT8 + - GEOGRAPHY + - GEOMETRY + - INT + - INTEGER + - NUMBER + - NUMERIC + - OBJECT + - REAL + - STRING + - SMALLINT + - TEXT + - TIME + - TIMESTAMP_LTZ + - TIMESTAMP_NTZ + - TIMESTAMP_TZ + - TINYINT + - VARBINARY + - VARCHAR + - VARIANT + - VECTOR + x-enum-varnames: + - ARRAY + - BIGINT + - BINARY + - BOOLEAN + - BYTEINT + - CHAR + - CHARACTER + - DATE + - DATETIME + - DECIMAL + - DOUBLE + - DOUBLE_PRECISION + - FLOAT + - FLOAT4 + - FLOAT8 + - GEOGRAPHY + - GEOMETRY + - INT + - INTEGER + - NUMBER + - NUMERIC + - OBJECT + - REAL + - STRING + - SMALLINT + - TEXT + - TIME + - TIMESTAMP_LTZ + - TIMESTAMP_NTZ + - TIMESTAMP_TZ + - TINYINT + - VARBINARY + - VARCHAR + - VARIANT + - VECTOR + description: Argument data type + default_value: + type: string + description: Default value of the argument + required: + - name + - datatype + ReturnType: + type: object + properties: + type: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Type of the return, can be either DATATYPE or TABLE + required: + - type + discriminator: + propertyName: type + mapping: + DATATYPE: ReturnDataType + TABLE: ReturnTable + ReturnDataType: + allOf: + - $ref: '#/components/schemas/ReturnType' + properties: + datatype: + type: string + enum: + - ARRAY + - BIGINT + - BINARY + - BOOLEAN + - BYTEINT + - CHAR + - CHARACTER + - DATE + - DATETIME + - DECIMAL + - DOUBLE + - DOUBLE PRECISION + - FLOAT + - FLOAT4 + - FLOAT8 + - GEOGRAPHY + - GEOMETRY + - INT + - INTEGER + - NUMBER + - NUMERIC + - OBJECT + - REAL + - STRING + - SMALLINT + - TEXT + - TIME + - TIMESTAMP_LTZ + - TIMESTAMP_NTZ + - TIMESTAMP_TZ + - TINYINT + - VARBINARY + - VARCHAR + - VARIANT + - VECTOR + x-enum-varnames: + - ARRAY + - BIGINT + - BINARY + - BOOLEAN + - BYTEINT + - CHAR + - CHARACTER + - DATE + - DATETIME + - DECIMAL + - DOUBLE + - DOUBLE_PRECISION + - FLOAT + - FLOAT4 + - FLOAT8 + - GEOGRAPHY + - GEOMETRY + - INT + - INTEGER + - NUMBER + - NUMERIC + - OBJECT + - REAL + - STRING + - SMALLINT + - TEXT + - TIME + - TIMESTAMP_LTZ + - TIMESTAMP_NTZ + - TIMESTAMP_TZ + - TINYINT + - VARBINARY + - VARCHAR + - VARIANT + - VECTOR + description: Return data type + nullable: + type: boolean + description: Argument null return acceptance criteria + required: + - datatype + ReturnTable: + allOf: + - $ref: '#/components/schemas/ReturnType' + properties: + column_list: + type: array + items: + $ref: '#/components/schemas/ColumnType' + description: List of table columns to return + ColumnType: + type: object + properties: + name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Argument name + datatype: + type: string + enum: + - ARRAY + - BIGINT + - BINARY + - BOOLEAN + - BYTEINT + - CHAR + - CHARACTER + - DATE + - DATETIME + - DECIMAL + - DOUBLE + - DOUBLE PRECISION + - FLOAT + - FLOAT4 + - FLOAT8 + - GEOGRAPHY + - GEOMETRY + - INT + - INTEGER + - NUMBER + - NUMERIC + - OBJECT + - REAL + - STRING + - SMALLINT + - TEXT + - TIME + - TIMESTAMP_LTZ + - TIMESTAMP_NTZ + - TIMESTAMP_TZ + - TINYINT + - VARBINARY + - VARCHAR + - VARIANT + - VECTOR + x-enum-varnames: + - ARRAY + - BIGINT + - BINARY + - BOOLEAN + - BYTEINT + - CHAR + - CHARACTER + - DATE + - DATETIME + - DECIMAL + - DOUBLE + - DOUBLE_PRECISION + - FLOAT + - FLOAT4 + - FLOAT8 + - GEOGRAPHY + - GEOMETRY + - INT + - INTEGER + - NUMBER + - NUMERIC + - OBJECT + - REAL + - STRING + - SMALLINT + - TEXT + - TIME + - TIMESTAMP_LTZ + - TIMESTAMP_NTZ + - TIMESTAMP_TZ + - TINYINT + - VARBINARY + - VARCHAR + - VARIANT + - VECTOR + description: Argument data type + required: + - name + - datatype + FunctionLanguage: + type: object + properties: + language: + type: string + description: 'Language that the function/procedure is written in. Possible + values include: JAVA, JAVASCRIPT, PYTHON, SCALA, SQL' + called_on_null_input: + type: boolean + description: Decide if the function/procedure can receive null input + is_volatile: + type: boolean + description: " Specifies the behavior of the UDF when returning results.\ + \ This Field is deprecated for Procedure.\n \n If\ + \ true, UDF might return different values for different rows, even for\ + \ the same input. \n This field is deprecated for Procedure.\n\ + \n If false, UDF assumes that the function, when called with\ + \ the same inputs, will always return the same result. \n This\ + \ guarantee is not checked. Specifying IMMUTABLE for a UDF that returns\ + \ different values for the same input will result in undefined behavior.\n\ + \ " + required: + - language + discriminator: + propertyName: language + mapping: + JAVA: JavaFunction + PYTHON: PythonFunction + SCALA: ScalaFunction + JAVASCRIPT: JavaScriptFunction + SQL: SQLFunction + BaseLanguage: + allOf: + - $ref: '#/components/schemas/FunctionLanguage' + properties: + packages: + type: array + items: + type: string + description: Packages to include with the function/procedure + imports: + type: array + items: + type: string + description: List of imports + handler: + type: string + description: Fully qualified method name including the package and the class + required: + - packages + - handler + JavaFunction: + allOf: + - $ref: '#/components/schemas/BaseLanguage' + properties: + external_access_integrations: + type: array + items: + type: string + description: List of external access integrations attached to this function/procedure + secrets: + type: object + additionalProperties: + type: string + description: Secrets to be used with this function/procedure for external + access + target_path: + type: string + description: Specifies where Snowflake should write the compiled code for + inline procedures + runtime_version: + type: string + description: "Specifies the Java JDK runtime version to use. \n \ + \ The supported versions of Java are 11.x and 17.x (Preview\ + \ support)" + required: + - runtime_version + PythonFunction: + allOf: + - $ref: '#/components/schemas/BaseLanguage' + properties: + external_access_integrations: + type: array + items: + type: string + description: List of external access integrations attached to this function/procedure + secrets: + type: object + additionalProperties: + type: string + description: Secrets to be used with this function/procedure for external + access + runtime_version: + type: string + description: "Specifies the Python version to use. The supported versions\ + \ of Python are:\n * 3.8\n \ + \ * 3.9\n * 3.10\n *\ + \ 3.11" + required: + - runtime_version + ScalaFunction: + allOf: + - $ref: '#/components/schemas/BaseLanguage' + properties: + target_path: + type: string + description: Specifies where Snowflake should write the compiled code for + inline function/procedures + runtime_version: + type: string + description: 'Specifies the Scala runtime version to use. The supported + versions of Scala are: 2.12' + required: + - runtime_version + JavaScriptFunction: + allOf: + - $ref: '#/components/schemas/FunctionLanguage' + SQLFunction: + allOf: + - $ref: '#/components/schemas/FunctionLanguage' + securitySchemes: + KeyPair: + $ref: common.yaml#/components/securitySchemes/KeyPair + ExternalOAuth: + $ref: common.yaml#/components/securitySchemes/ExternalOAuth + SnowflakeOAuth: + $ref: common.yaml#/components/securitySchemes/SnowflakeOAuth +security: +- KeyPair: [] +- ExternalOAuth: [] +- SnowflakeOAuth: [] diff --git a/releases/8.40/specifications/user.yaml b/releases/8.40/specifications/user.yaml new file mode 100644 index 0000000..b5eb59b --- /dev/null +++ b/releases/8.40/specifications/user.yaml @@ -0,0 +1,603 @@ +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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + 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 + Link: + $ref: common.yaml#/components/headers/Link + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + Link: + $ref: common.yaml#/components/headers/Link + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + put: + summary: Create a (or alter an existing) user. + description: Create a (or alter an existing) user. Even if the operation is + just an alter, the full property set must be provided. Note that password + is not currently altered by this operation but is supported for a newly-created + object. + operationId: createOrAlterUser + tags: + - user + parameters: + - $ref: common.yaml#/components/parameters/name + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/users/{name}/grants: + get: + parameters: + - $ref: common.yaml#/components/parameters/name + - $ref: common.yaml#/components/parameters/showLimit + summary: List all grants to the user + tags: + - user + description: List all grants to the user + operationId: listGrants + responses: + '200': + description: successful + headers: + X-Snowflake-Request-ID: + $ref: common.yaml#/components/headers/X-Snowflake-Request-ID + Link: + $ref: common.yaml#/components/headers/Link + content: + application/json: + schema: + type: array + items: + $ref: '#/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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + post: + summary: Grant a role to the user + tags: + - user + description: Grant a role to the user + operationId: grant + parameters: + - $ref: common.yaml#/components/parameters/name + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /api/v2/users/{name}/grants:revoke: + post: + summary: Revoke grants from the user + tags: + - user + description: Revoke grants from the user + operationId: revokeGrants + parameters: + - $ref: common.yaml#/components/parameters/name + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +components: + schemas: + Grant: + type: object + properties: + securable: + $ref: '#/components/schemas/Securable' + description: Securable of the grant + containing_scope: + $ref: '#/components/schemas/ContainingScope' + description: Containing scope of the grant + securable_type: + type: string + description: Type of the securable to be granted. Only ROLE is supported + privileges: + type: array + items: + type: string + description: List of privileges to be granted. + created_on: + type: string + format: date-time + readOnly: true + description: Date and time when the grant was created + granted_by: + type: string + readOnly: true + description: The role that granted this privilege to this grantee + required: + - securable_type + Securable: + type: object + properties: + database: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Database name of the securable if applicable. + schema: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Schema name of the securable if applicable. + name: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Name of the securable if applicable. + required: + - name + ContainingScope: + type: object + properties: + database: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Database name of the securable scope if applicable. + schema: + type: string + pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$ + description: Schema name of the securable scope if applicable. + required: + - database + User: + description: Properties of user. + type: object + required: + - name + properties: + name: + type: string + description: User name + example: jackpatel + password: + type: string + format: password + 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 values are ALL or NONE. Default is ALL after + 2024-07 BCR. + enum: + - ALL + - NONE + default: 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_2: + type: string + description: Second RSA public key of the user + comment: + type: string + description: Comment about the user. + example: A distinguished user + type: + type: string + description: Indicates the type of user (PERSON | SERVICE | LEGACY_SERVICE) + enable_unredacted_query_syntax_error: + type: boolean + description: Whether to show unredacted query syntax errors in the query + history. + network_policy: + type: string + description: Specifies an existing network policy is active for the user. + Otherwise, use account default. + 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 + rsa_public_key_fp: + type: string + readOnly: true + description: Fingerprint of the user's RSA public key + rsa_public_key_2_fp: + type: string + readOnly: true + description: Fingerprint of the user's second RSA public key + 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 + securitySchemes: + KeyPair: + $ref: common.yaml#/components/securitySchemes/KeyPair + ExternalOAuth: + $ref: common.yaml#/components/securitySchemes/ExternalOAuth + SnowflakeOAuth: + $ref: common.yaml#/components/securitySchemes/SnowflakeOAuth +security: +- KeyPair: [] +- ExternalOAuth: [] +- SnowflakeOAuth: [] diff --git a/releases/8.40/specifications/view.yaml b/releases/8.40/specifications/view.yaml new file mode 100644 index 0000000..d5c6dbd --- /dev/null +++ b/releases/8.40/specifications/view.yaml @@ -0,0 +1,290 @@ +openapi: 3.0.0 +servers: +- description: Snowflake REST Server + url: https://org-account.snowflakecomputing.com +info: + version: 0.0.1 + title: Snowflake View API + description: The Snowflake View API is a REST API that you can use to access, update, + and perform certain actions on View resource in a Snowflake database. + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/databases/{database}/schemas/{schema}/views: + get: + summary: List views + tags: + - view + description: List views + operationId: listViews + 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 view. + 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/View' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + post: + summary: Create a view + tags: + - view + description: Create a view + operationId: createView + 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 + responses: + '200': + $ref: common.yaml#/components/responses/200SuccessResponse + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/View' + /api/v2/databases/{database}/schemas/{schema}/views/{name}: + get: + summary: Fetch a view + tags: + - view + description: Fetch a view + operationId: fetchView + 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/View' + '202': + $ref: common.yaml#/components/responses/202SuccessAcceptedResponse + '400': + $ref: common.yaml#/components/responses/400BadRequest + '401': + $ref: common.yaml#/components/responses/401Unauthorized + '403': + $ref: common.yaml#/components/responses/403Forbidden + '404': + $ref: common.yaml#/components/responses/404NotFound + '405': + $ref: common.yaml#/components/responses/405MethodNotAllowed + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + delete: + summary: Delete a view + tags: + - view + description: Delete a view + operationId: deleteView + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +components: + schemas: + View: + type: object + description: A Snowflake view + properties: + name: + type: string + description: Name of the view + secure: + type: boolean + description: Whether or not this view is secure + kind: + type: string + enum: + - PERMANENT + - TEMPORARY + description: Kind of the view, permanent (default) or temporary + recursive: + type: boolean + description: Whether or not this view can refer to itself using recursive + syntax withot requiring a CTE (common table expression) + columns: + type: array + items: + $ref: '#/components/schemas/ViewColumn' + description: The columns of the view + comment: + type: string + description: user comment associated to an object in the dictionary + query: + type: string + description: Query used to create the view + created_on: + type: string + format: date-time + readOnly: true + description: Date and time when the view was created. + database_name: + type: string + readOnly: true + description: Database in which the view is stored + schema_name: + type: string + readOnly: true + description: Schema in which the view is stored + owner: + type: string + readOnly: true + description: Role that owns the view + owner_role_type: + type: string + readOnly: true + description: The type of role that owns the view + required: + - name + - columns + - query + ViewColumn: + type: object + description: A column specifier in the view + properties: + name: + type: string + description: Column name + comment: + type: string + description: Specifies a comment for the column + datatype: + type: string + readOnly: true + description: The data type for the column + required: + - name + securitySchemes: + KeyPair: + $ref: common.yaml#/components/securitySchemes/KeyPair + ExternalOAuth: + $ref: common.yaml#/components/securitySchemes/ExternalOAuth + SnowflakeOAuth: + $ref: common.yaml#/components/securitySchemes/SnowflakeOAuth +security: +- KeyPair: [] +- ExternalOAuth: [] +- SnowflakeOAuth: [] diff --git a/releases/8.40/specifications/warehouse.yaml b/releases/8.40/specifications/warehouse.yaml new file mode 100644 index 0000000..16047f4 --- /dev/null +++ b/releases/8.40/specifications/warehouse.yaml @@ -0,0 +1,645 @@ +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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + 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 + Link: + $ref: common.yaml#/components/headers/Link + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + Link: + $ref: common.yaml#/components/headers/Link + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + 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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout + /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 + '408': + $ref: common.yaml#/components/responses/408RequestTimeout + '409': + $ref: common.yaml#/components/responses/409Conflict + '410': + $ref: common.yaml#/components/responses/410Gone + '429': + $ref: common.yaml#/components/responses/429LimitExceeded + '500': + $ref: common.yaml#/components/responses/500InternalServerError + '503': + $ref: common.yaml#/components/responses/503ServiceUnavailable + '504': + $ref: common.yaml#/components/responses/504GatewayTimeout +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 + securitySchemes: + KeyPair: + $ref: common.yaml#/components/securitySchemes/KeyPair + ExternalOAuth: + $ref: common.yaml#/components/securitySchemes/ExternalOAuth + SnowflakeOAuth: + $ref: common.yaml#/components/securitySchemes/SnowflakeOAuth +security: +- KeyPair: [] +- ExternalOAuth: [] +- SnowflakeOAuth: []