diff --git a/.github/repo_meta.yaml b/.github/repo_meta.yaml index 74cd49b..a7ef8f8 100644 --- a/.github/repo_meta.yaml +++ b/.github/repo_meta.yaml @@ -1,7 +1,7 @@ # Make sure this file is valid yaml, otherwise it will not be recognized by security audits # point_of_contact: the owner of this repository, can be a GitHub user or GitHub team. Do NOT use the '@' symbol -point_of_contact: +point_of_contact: "@snowflakedb/snowapi" # production: whether this repository meets the criteria for being "production", see # go/production-repository-criteria for criteria @@ -34,5 +34,5 @@ code_owners_file_present: true jira_project_issue_type: Bug # jira_area: the Jira area that raised issues should use -jira_area: Orphaned +jira_area: "Snowpark: Application Development Ecosystem" diff --git a/.gitignore b/.gitignore index 921447b..f4b4b6a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ # Created by https://www.gitignore.io/api/c,c++,node,java,python,intellij,netbeans # Edit at https://www.gitignore.io/?templates=c,c++,node,java,python,intellij,netbeans +.DS_Store ### C ### # Prerequisites diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..85077cf --- /dev/null +++ b/LICENSE @@ -0,0 +1,13 @@ +Copyright (c) 2023 Snowflake Inc. + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/Readme.md b/Readme.md index 9523a2f..d36de90 100644 --- a/Readme.md +++ b/Readme.md @@ -1,24 +1,3 @@ -## Stub readme file +## Snowflake Rest Api Specs -This is a *stub* readme file to descibe your project - -Please update it with contact information for your repository and team. - -Formatting help can be found at [github](https://help.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax) - -## Requirements for private repositories - -If this repository is intended to be private, please see the [CM requirements](https://snowflakecomputing.atlassian.net/wiki/spaces/~367958958/pages/671909031/Creating+a+new+repository) - -## Metadata Requirements - -This repository must have a metadata file located at `/.github/repo_meta.yaml`. This template repository already includes [that file](./.github/repo_meta.yaml). - -In addition to having a metadata file, this repository must define the following metadata in the metadata file: -* `production` - set this field to `true` if this repository is used to develop, build, or deploy production services. Set this field to `false` otherwise. `true` is the default setting. -* `point_of_contact` - set this field to the GitHub user or team that should be the point of contact for this repository. -* `distributed` - set this field to true if code from this repository (including binaries created from this repository) is downloaded by or onto non-Snowflake computers”. Set this field to `false` otherwise. `false` is the default setting. For more information, please check [Snowflake Open Source Policy](https://docs.google.com/document/d/1lsyiafPrn_j5X10hMl62S6cVn26ru_Oxbnh9L6tgav4) -* `modified` - set this filed to `true` if the open source code in the repository is modified in anyway. Set this field to `false` otherwise. `false` is the default setting. -* `code_owners_file_present` - set this field to `true` if this repository includes a code owners file. Set this field to `false` otherwise. `true` is the default setting. -* `jira_project_issue_type` - set this field with jira project and related issue type (e.g., `SNOW/BUG`). -* `jira_area` - set this field with jira project area (e.g., `Data Platform: Ecosystem`). +This repository is the source for REST API specifications for Snowflake. diff --git a/collection/private-preview/2023-11-13-private-preview/Snowflake Compute Pools API.postman_collection.json b/collection/private-preview/2023-11-13-private-preview/Snowflake Compute Pools API.postman_collection.json new file mode 100644 index 0000000..8ec591d --- /dev/null +++ b/collection/private-preview/2023-11-13-private-preview/Snowflake Compute Pools API.postman_collection.json @@ -0,0 +1,3137 @@ +{ + "info": { + "_postman_id": "991bc617-04b4-4650-9bed-01b35e8b33ff", + "name": "Snowflake Compute Pools API", + "description": "The Snowflake Compute Pools API is a REST API that you can use to access, update, and perform certain actions on Compute Pool resources.\n\nContact Support:\n Name: Snowflake, Inc.\n Email: support@snowflake.com", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "_exporter_id": "28868798", + "_collection_link": "https://snowflake.postman.co/workspace/SnowApi-Demo~576e3337-09c5-4d42-a068-1fb91ebec0b9/collection/28868798-991bc617-04b4-4650-9bed-01b35e8b33ff?action=share&source=collection_link&creator=28868798" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "compute-pools", + "item": [ + { + "name": "{name}", + "item": [ + { + "name": "Fetch a compute pool.", + "request": { + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "value", + "value": "Snowflake Token=\"{{sessionToken}}\"", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + }, + { + "key": "key", + "value": "Authorization", + "type": "string" + } + ] + }, + "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": "{{compute_pool_name}}", + "description": "(Required) " + } + ] + }, + "description": "Fetch a compute pool using the SHOW command output." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"name\": \"CZ82wIQJ\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"warehouse\": \"hYkM0DuY\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"state\": \"SUSPENDED\",\n \"num_services\": \"\",\n \"auto_suspend_secs\": \"\",\n \"active_nodes\": \"\",\n \"idle_nodes\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\"\n}" + }, + { + "name": "Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct request payload. The response body may include the error code and message indicating the actual cause. The application must reconstruct the r", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response body may include the error code and message indicating the actual cause, e.g., expired, invalid token. The application must obtain a", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Method Not Allowed. The request method doesn't match the supported API. This happens, for example, if the application calls the API with GET method but the endpoint accepts only POST.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Internal Server Error. The server hit an unrecoverable system error. The response body may include the error code and message for further guidance. The application owner may need to reach out the customer support.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "Delete a compute pool", + "request": { + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "value", + "value": "Snowflake Token=\"{{sessionToken}}\"", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + }, + { + "key": "key", + "value": "Authorization", + "type": "string" + } + ] + }, + "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" + } + ], + "variable": [ + { + "key": "name", + "value": "{{compute_pool_name}}", + "description": "(Required) " + } + ] + }, + "description": "Delete a compute pool with the given name. If ifExists is used, the operation will succeed even if the object does not exist. Otherwise, there will be a 404 failure if the drop is unsuccessful." + }, + "response": [ + { + "name": "Successful", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false" + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct request payload. The response body may include the error code and message indicating the actual cause. The application must reconstruct the r", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false" + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response body may include the error code and message indicating the actual cause, e.g., expired, invalid token. The application must obtain a", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false" + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false" + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false" + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Method Not Allowed. The request method doesn't match the supported API. This happens, for example, if the application calls the API with GET method but the endpoint accepts only POST.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false" + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Internal Server Error. The server hit an unrecoverable system error. The response body may include the error code and message for further guidance. The application owner may need to reach out the customer support.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false" + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false" + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false" + } + ], + "variable": [ + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:resume", + "item": [ + { + "name": "Resume a compute pool", + "request": { + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "value", + "value": "Snowflake Token=\"{{sessionToken}}\"", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + }, + { + "key": "key", + "value": "Authorization", + "type": "string" + } + ] + }, + "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. This is a no-op if it is already running." + }, + "response": [ + { + "name": "Successful", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:resume" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct request payload. The response body may include the error code and message indicating the actual cause. The application must reconstruct the r", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:resume" + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response body may include the error code and message indicating the actual cause, e.g., expired, invalid token. The application must obtain a", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:resume" + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:resume" + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:resume" + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Method Not Allowed. The request method doesn't match the supported API. This happens, for example, if the application calls the API with GET method but the endpoint accepts only POST.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:resume" + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Internal Server Error. The server hit an unrecoverable system error. The response body may include the error code and message for further guidance. The application owner may need to reach out the customer support.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:resume" + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:resume" + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:resume" + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:suspend", + "item": [ + { + "name": "Perform an action on a compute pool", + "request": { + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "value", + "value": "Snowflake Token=\"{{sessionToken}}\"", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + }, + { + "key": "key", + "value": "Authorization", + "type": "string" + } + ] + }, + "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." + }, + "response": [ + { + "name": "Successful", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:suspend" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct request payload. The response body may include the error code and message indicating the actual cause. The application must reconstruct the r", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:suspend" + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response body may include the error code and message indicating the actual cause, e.g., expired, invalid token. The application must obtain a", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:suspend" + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:suspend" + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:suspend" + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Method Not Allowed. The request method doesn't match the supported API. This happens, for example, if the application calls the API with GET method but the endpoint accepts only POST.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:suspend" + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Internal Server Error. The server hit an unrecoverable system error. The response body may include the error code and message for further guidance. The application owner may need to reach out the customer support.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:suspend" + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:suspend" + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:suspend" + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:stopallservices", + "item": [ + { + "name": "Stops all services on the compute pool.", + "request": { + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "value", + "value": "Snowflake Token=\"{{sessionToken}}\"", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + }, + { + "key": "key", + "value": "Authorization", + "type": "string" + } + ] + }, + "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": "Stop all services in the compute pool." + }, + "response": [ + { + "name": "Successful", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stopallservices", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stopallservices" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct request payload. The response body may include the error code and message indicating the actual cause. The application must reconstruct the r", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stopallservices", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stopallservices" + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response body may include the error code and message indicating the actual cause, e.g., expired, invalid token. The application must obtain a", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stopallservices", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stopallservices" + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stopallservices", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stopallservices" + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stopallservices", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stopallservices" + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Method Not Allowed. The request method doesn't match the supported API. This happens, for example, if the application calls the API with GET method but the endpoint accepts only POST.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stopallservices", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stopallservices" + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Internal Server Error. The server hit an unrecoverable system error. The response body may include the error code and message for further guidance. The application owner may need to reach out the customer support.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stopallservices", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stopallservices" + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stopallservices", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stopallservices" + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools/{{name}}:stopallservices", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools", + "{{name}}:stopallservices" + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "List compute pools", + "request": { + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "value", + "value": "Snowflake Token=\"{{sessionToken}}\"", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + }, + { + "key": "key", + "value": "Authorization", + "type": "string" + } + ] + }, + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?like=%computePoolName%&startsWith=compute%&showLimit=10", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "like", + "value": "%computePoolName%" + }, + { + "key": "startsWith", + "value": "compute%" + }, + { + "key": "showLimit", + "value": "10" + } + ] + }, + "description": "Lists the compute pools under the account." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?like=&startsWith=&showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "like", + "value": "" + }, + { + "key": "startsWith", + "value": "" + }, + { + "key": "showLimit", + "value": "" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"_dBj\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"warehouse\": \"jprqFqc\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"state\": \"RESIZING\",\n \"num_services\": \"\",\n \"auto_suspend_secs\": \"\",\n \"active_nodes\": \"\",\n \"idle_nodes\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\"\n },\n {\n \"name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\\\"\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"warehouse\": \"\\\",\\\"\\\"\\\"\\\"#\\\"\\\"\\\"\\\"\\\"\\\"F\\\"\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"state\": \"RESIZING\",\n \"num_services\": \"\",\n \"auto_suspend_secs\": \"\",\n \"active_nodes\": \"\",\n \"idle_nodes\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\"\n }\n]" + }, + { + "name": "Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct request payload. The response body may include the error code and message indicating the actual cause. The application must reconstruct the r", + "originalRequest": { + "method": "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": "" + }, + { + "key": "startsWith", + "value": "" + }, + { + "key": "showLimit", + "value": "" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response body may include the error code and message indicating the actual cause, e.g., expired, invalid token. The application must obtain a", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?like=&startsWith=&showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "like", + "value": "" + }, + { + "key": "startsWith", + "value": "" + }, + { + "key": "showLimit", + "value": "" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?like=&startsWith=&showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "like", + "value": "" + }, + { + "key": "startsWith", + "value": "" + }, + { + "key": "showLimit", + "value": "" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?like=&startsWith=&showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "like", + "value": "" + }, + { + "key": "startsWith", + "value": "" + }, + { + "key": "showLimit", + "value": "" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Method Not Allowed. The request method doesn't match the supported API. This happens, for example, if the application calls the API with GET method but the endpoint accepts only POST.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?like=&startsWith=&showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "like", + "value": "" + }, + { + "key": "startsWith", + "value": "" + }, + { + "key": "showLimit", + "value": "" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Internal Server Error. The server hit an unrecoverable system error. The response body may include the error code and message for further guidance. The application owner may need to reach out the customer support.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?like=&startsWith=&showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "like", + "value": "" + }, + { + "key": "startsWith", + "value": "" + }, + { + "key": "showLimit", + "value": "" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?like=&startsWith=&showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "like", + "value": "" + }, + { + "key": "startsWith", + "value": "" + }, + { + "key": "showLimit", + "value": "" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?like=&startsWith=&showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "like", + "value": "" + }, + { + "key": "startsWith", + "value": "" + }, + { + "key": "showLimit", + "value": "" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "Create a compute pool", + "request": { + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "value", + "value": "Snowflake Token=\"{{sessionToken}}\"", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + }, + { + "key": "key", + "value": "Authorization", + "type": "string" + } + ] + }, + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"{{compute_pool_name}}\",\n \"instance_family\": \"family\",\n \"min_nodes\": 3,\n \"max_nodes\": 10,\n \"auto_resume\": true,\n \"auto_suspend_secs\": 10\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?createMode=ifNotExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "createMode", + "value": "ifNotExists" + } + ] + }, + "description": "Create 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", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"CZ82wIQJ\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"warehouse\": \"hYkM0DuY\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"state\": \"SUSPENDED\",\n \"num_services\": \"\",\n \"auto_suspend_secs\": \"\",\n \"active_nodes\": \"\",\n \"idle_nodes\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct 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\": \"CZ82wIQJ\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"warehouse\": \"hYkM0DuY\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"state\": \"SUSPENDED\",\n \"num_services\": \"\",\n \"auto_suspend_secs\": \"\",\n \"active_nodes\": \"\",\n \"idle_nodes\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response 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\": \"CZ82wIQJ\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"warehouse\": \"hYkM0DuY\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"state\": \"SUSPENDED\",\n \"num_services\": \"\",\n \"auto_suspend_secs\": \"\",\n \"active_nodes\": \"\",\n \"idle_nodes\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "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\": \"CZ82wIQJ\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"warehouse\": \"hYkM0DuY\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"state\": \"SUSPENDED\",\n \"num_services\": \"\",\n \"auto_suspend_secs\": \"\",\n \"active_nodes\": \"\",\n \"idle_nodes\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Not Found. 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\": \"CZ82wIQJ\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"warehouse\": \"hYkM0DuY\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"state\": \"SUSPENDED\",\n \"num_services\": \"\",\n \"auto_suspend_secs\": \"\",\n \"active_nodes\": \"\",\n \"idle_nodes\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Method Not Allowed. The request method doesn't match 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\": \"CZ82wIQJ\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"warehouse\": \"hYkM0DuY\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"state\": \"SUSPENDED\",\n \"num_services\": \"\",\n \"auto_suspend_secs\": \"\",\n \"active_nodes\": \"\",\n \"idle_nodes\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\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\": \"CZ82wIQJ\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"warehouse\": \"hYkM0DuY\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"state\": \"SUSPENDED\",\n \"num_services\": \"\",\n \"auto_suspend_secs\": \"\",\n \"active_nodes\": \"\",\n \"idle_nodes\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Internal Server Error. The server hit an unrecoverable system error. The response 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\": \"CZ82wIQJ\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"warehouse\": \"hYkM0DuY\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"state\": \"SUSPENDED\",\n \"num_services\": \"\",\n \"auto_suspend_secs\": \"\",\n \"active_nodes\": \"\",\n \"idle_nodes\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Service 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\": \"CZ82wIQJ\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"warehouse\": \"hYkM0DuY\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"state\": \"SUSPENDED\",\n \"num_services\": \"\",\n \"auto_suspend_secs\": \"\",\n \"active_nodes\": \"\",\n \"idle_nodes\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gateway 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\": \"CZ82wIQJ\",\n \"instance_family\": \"\",\n \"min_nodes\": \"\",\n \"max_nodes\": \"\",\n \"warehouse\": \"hYkM0DuY\",\n \"auto_resume\": \"\",\n \"comment\": \"\",\n \"state\": \"SUSPENDED\",\n \"num_services\": \"\",\n \"auto_suspend_secs\": \"\",\n \"active_nodes\": \"\",\n \"idle_nodes\": \"\",\n \"created_on\": \"\",\n \"resumed_on\": \"\",\n \"updated_on\": \"\",\n \"owner\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/compute-pools?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "compute-pools" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + } + ] + } + ] + } + ], + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + }, + { + "key": "name", + "value": "gVWQ" + }, + { + "key": "name", + "value": "gVWQ" + }, + { + "key": "name", + "value": "gVWQ" + } + ] +} \ No newline at end of file diff --git a/collection/private-preview/2023-11-13-private-preview/Snowflake Image Repositories API.postman_collection.json b/collection/private-preview/2023-11-13-private-preview/Snowflake Image Repositories API.postman_collection.json new file mode 100644 index 0000000..e1b5b53 --- /dev/null +++ b/collection/private-preview/2023-11-13-private-preview/Snowflake Image Repositories API.postman_collection.json @@ -0,0 +1,2484 @@ +{ + "info": { + "_postman_id": "8fc545f0-179f-47d8-b439-2bc97d3f9ede", + "name": "Snowflake Image Repositories API", + "description": "The Snowflake Image Repositories API is a REST API that you can use to access, update, and perform certain actions on Image Repository resources in Snowflake.\n\nContact Support:\n Name: Snowflake, Inc.\n Email: support@snowflake.com", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "_exporter_id": "28868798", + "_collection_link": "https://snowflake.postman.co/workspace/SnowApi-Demo~576e3337-09c5-4d42-a068-1fb91ebec0b9/collection/28868798-8fc545f0-179f-47d8-b439-2bc97d3f9ede?action=share&source=collection_link&creator=28868798" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "databases", + "item": [ + { + "name": "{database}", + "item": [ + { + "name": "schemas", + "item": [ + { + "name": "{schema}", + "item": [ + { + "name": "image-repositories", + "item": [ + { + "name": "{name}", + "item": [ + { + "name": "Fetch an image repository.", + "request": { + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "value", + "value": "Snowflake Token=\"{{sessionToken}}\"", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + }, + { + "key": "key", + "value": "Authorization", + "type": "string" + } + ] + }, + "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": "{{database}}", + "description": "(Required) " + }, + { + "key": "schema", + "value": "{{schema}}", + "description": "(Required) " + }, + { + "key": "name", + "value": "{{image_repository_name}}", + "description": "(Required) " + } + ] + }, + "description": "Fetch an image repository using the SHOW command output." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"w~\\\"\\\"z\\\"\\\"\\\"\",\n \"database_name\": \"J\",\n \"schema_name\": \"\\\"\\\"\\\"9\\\"\\\"\\\"\",\n \"created_on\": \"\",\n \"repository_url\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\"\n}" + }, + { + "name": "Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct request payload. The response body may include the error code and message indicating the actual cause. The application must reconstruct the r", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response body may include the error code and message indicating the actual cause, e.g., expired, invalid token. The application must obtain a", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Method Not Allowed. The request method doesn't match the supported API. This happens, for example, if the application calls the API with GET method but the endpoint accepts only POST.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Internal Server Error. The server hit an unrecoverable system error. The response body may include the error code and message for further guidance. The application owner may need to reach out the customer support.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "Delete an image repository", + "request": { + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "value", + "value": "Snowflake Token=\"{{sessionToken}}\"", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + }, + { + "key": "key", + "value": "Authorization", + "type": "string" + } + ] + }, + "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" + } + ], + "variable": [ + { + "key": "database", + "value": "{{database}}", + "description": "(Required) " + }, + { + "key": "schema", + "value": "{{schema}}", + "description": "(Required) " + }, + { + "key": "name", + "value": "{{image_repository_name}}", + "description": "(Required) " + } + ] + }, + "description": "Delete an image repository 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", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct request payload. The response body may include the error code and message indicating the actual cause. The application must reconstruct the r", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response body may include the error code and message indicating the actual cause, e.g., expired, invalid token. The application must obtain a", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Method Not Allowed. The request method doesn't match the supported API. This happens, for example, if the application calls the API with GET method but the endpoint accepts only POST.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Internal Server Error. The server hit an unrecoverable system error. The response body may include the error code and message for further guidance. The application owner may need to reach out the customer support.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "List image repositories", + "request": { + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "value", + "value": "Snowflake Token=\"{{sessionToken}}\"", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + }, + { + "key": "key", + "value": "Authorization", + "type": "string" + } + ] + }, + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?like=%imageRepositoryName%", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "like", + "value": "%imageRepositoryName%" + } + ], + "variable": [ + { + "key": "database", + "value": "{{database}}", + "description": "(Required) " + }, + { + "key": "schema", + "value": "{{schema}}", + "description": "(Required) " + } + ] + }, + "description": "Lists the image repositories under the database and schema." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "like", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"_QI7\",\n \"database_name\": \"\\\",\\\"\",\n \"schema_name\": \"\\\"\\\"\\\"\\\"\\\"\\\"\\\"YB\\\"\\\"\\\"\\\"\\\"\",\n \"created_on\": \"\",\n \"repository_url\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\"\n },\n {\n \"name\": \"NxVOOv\",\n \"database_name\": \"\\\"n\\\"\\\"\\\"\\\"\\\"\\\"k\\\"\\\"\\\"\\\"Q\\\"\\\"r\\\"\",\n \"schema_name\": \"VoNKPUq\",\n \"created_on\": \"\",\n \"repository_url\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\"\n }\n]" + }, + { + "name": "Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct request payload. The response body may include the error code and message indicating the actual cause. The application must reconstruct the r", + "originalRequest": { + "method": "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": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response body may include the error code and message indicating the actual cause, e.g., expired, invalid token. The application must obtain a", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "like", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "like", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "like", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Method Not Allowed. The request method doesn't match the supported API. This happens, for example, if the application calls the API with GET method but the endpoint accepts only POST.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "like", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Conflict. The requested operation could not be performed due to a conflicting state that could not be resolved. This usually happens when a CREATE request was performed when there is a pre-existing resource with the same name, and also without one of the ", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "like", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Internal Server Error. The server hit an unrecoverable system error. The response body may include the error code and message for further guidance. The application owner may need to reach out the customer support.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "like", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "like", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?like=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "like", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "Create an image repository", + "request": { + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "value", + "value": "Snowflake Token=\"{{sessionToken}}\"", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + }, + { + "key": "key", + "value": "Authorization", + "type": "string" + } + ] + }, + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"{{image_repository_name}}\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?createMode=orReplace", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "createMode", + "value": "orReplace" + } + ], + "variable": [ + { + "key": "database", + "value": "{{database}}", + "description": "(Required) " + }, + { + "key": "schema", + "value": "{{schema}}", + "description": "(Required) " + } + ] + }, + "description": "Create an image repository, with standard create modifiers as query parameters. See the ImageRepository component definition for what is required to be provided in the request body." + }, + "response": [ + { + "name": "Successful", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"\\\"\\\"\\\"\\\"\\\"w~\\\"\\\"z\\\"\\\"\\\"\",\n \"database_name\": \"J\",\n \"schema_name\": \"\\\"\\\"\\\"9\\\"\\\"\\\"\",\n \"created_on\": \"\",\n \"repository_url\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct 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\": \"\\\"\\\"\\\"\\\"\\\"w~\\\"\\\"z\\\"\\\"\\\"\",\n \"database_name\": \"J\",\n \"schema_name\": \"\\\"\\\"\\\"9\\\"\\\"\\\"\",\n \"created_on\": \"\",\n \"repository_url\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response 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\": \"\\\"\\\"\\\"\\\"\\\"w~\\\"\\\"z\\\"\\\"\\\"\",\n \"database_name\": \"J\",\n \"schema_name\": \"\\\"\\\"\\\"9\\\"\\\"\\\"\",\n \"created_on\": \"\",\n \"repository_url\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "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\": \"\\\"\\\"\\\"\\\"\\\"w~\\\"\\\"z\\\"\\\"\\\"\",\n \"database_name\": \"J\",\n \"schema_name\": \"\\\"\\\"\\\"9\\\"\\\"\\\"\",\n \"created_on\": \"\",\n \"repository_url\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Not Found. 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\": \"\\\"\\\"\\\"\\\"\\\"w~\\\"\\\"z\\\"\\\"\\\"\",\n \"database_name\": \"J\",\n \"schema_name\": \"\\\"\\\"\\\"9\\\"\\\"\\\"\",\n \"created_on\": \"\",\n \"repository_url\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Method Not Allowed. The request method doesn't match 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\": \"\\\"\\\"\\\"\\\"\\\"w~\\\"\\\"z\\\"\\\"\\\"\",\n \"database_name\": \"J\",\n \"schema_name\": \"\\\"\\\"\\\"9\\\"\\\"\\\"\",\n \"created_on\": \"\",\n \"repository_url\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\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\": \"\\\"\\\"\\\"\\\"\\\"w~\\\"\\\"z\\\"\\\"\\\"\",\n \"database_name\": \"J\",\n \"schema_name\": \"\\\"\\\"\\\"9\\\"\\\"\\\"\",\n \"created_on\": \"\",\n \"repository_url\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Internal Server Error. The server hit an unrecoverable system error. The response 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\": \"\\\"\\\"\\\"\\\"\\\"w~\\\"\\\"z\\\"\\\"\\\"\",\n \"database_name\": \"J\",\n \"schema_name\": \"\\\"\\\"\\\"9\\\"\\\"\\\"\",\n \"created_on\": \"\",\n \"repository_url\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Service 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\": \"\\\"\\\"\\\"\\\"\\\"w~\\\"\\\"z\\\"\\\"\\\"\",\n \"database_name\": \"J\",\n \"schema_name\": \"\\\"\\\"\\\"9\\\"\\\"\\\"\",\n \"created_on\": \"\",\n \"repository_url\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gateway 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\": \"\\\"\\\"\\\"\\\"\\\"w~\\\"\\\"z\\\"\\\"\\\"\",\n \"database_name\": \"J\",\n \"schema_name\": \"\\\"\\\"\\\"9\\\"\\\"\\\"\",\n \"created_on\": \"\",\n \"repository_url\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/image-repositories?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "image-repositories" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\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/collection/private-preview/2023-11-13-private-preview/Snowflake Sessions API.postman_collection.json b/collection/private-preview/2023-11-13-private-preview/Snowflake Sessions API.postman_collection.json new file mode 100644 index 0000000..b0cdce9 --- /dev/null +++ b/collection/private-preview/2023-11-13-private-preview/Snowflake Sessions API.postman_collection.json @@ -0,0 +1,2027 @@ +{ + "info": { + "_postman_id": "5b5d94f2-fcac-4032-a88c-16783d9fd9a3", + "name": "Snowflake Sessions API", + "description": "The Snowflake Sessions API is a REST API that you can use to manage Snowflake sessions and session tokens.\n\nContact Support:\n Name: Snowflake, Inc.\n Email: support@snowflake.com", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "_exporter_id": "28868798", + "_collection_link": "https://snowflake.postman.co/workspace/SnowApi-Demo~576e3337-09c5-4d42-a068-1fb91ebec0b9/collection/28868798-5b5d94f2-fcac-4032-a88c-16783d9fd9a3?action=share&source=collection_link&creator=28868798" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "sessions", + "item": [ + { + "name": "{sessionId}", + "item": [ + { + "name": "Close a session", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "", + "pm.environment.set(\"sessionToken\", \"\");", + "pm.environment.set(\"masterToken\", \"\")", + "pm.environment.set(\"sessionId\", \"\")", + "" + ], + "type": "text/javascript" + } + } + ], + "request": { + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "value", + "value": "Snowflake Token=\"{{sessionToken}}\"", + "type": "string" + }, + { + "key": "key", + "value": "Authorization", + "type": "string" + } + ] + }, + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/sessions/:sessionId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions", + ":sessionId" + ], + "variable": [ + { + "key": "sessionId", + "value": "{{sessionId}}", + "description": "(Required) " + } + ] + }, + "description": "Close the current session" + }, + "response": [ + { + "name": "Successful", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "X-Sfc-Session", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: bearer", + "key": "Authorization", + "value": "Bearer " + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/sessions/:sessionId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions", + ":sessionId" + ], + "variable": [ + { + "key": "sessionId" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct 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": "X-Sfc-Session", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: bearer", + "key": "Authorization", + "value": "Bearer " + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/sessions/:sessionId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions", + ":sessionId" + ], + "variable": [ + { + "key": "sessionId" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response 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": "X-Sfc-Session", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: bearer", + "key": "Authorization", + "value": "Bearer " + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/sessions/:sessionId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions", + ":sessionId" + ], + "variable": [ + { + "key": "sessionId" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "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": "X-Sfc-Session", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: bearer", + "key": "Authorization", + "value": "Bearer " + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/sessions/:sessionId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions", + ":sessionId" + ], + "variable": [ + { + "key": "sessionId" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Not Found. 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": "X-Sfc-Session", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: bearer", + "key": "Authorization", + "value": "Bearer " + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/sessions/:sessionId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions", + ":sessionId" + ], + "variable": [ + { + "key": "sessionId" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Method Not Allowed. The request method doesn't match 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": "X-Sfc-Session", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: bearer", + "key": "Authorization", + "value": "Bearer " + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/sessions/:sessionId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions", + ":sessionId" + ], + "variable": [ + { + "key": "sessionId" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "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": "X-Sfc-Session", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: bearer", + "key": "Authorization", + "value": "Bearer " + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/sessions/:sessionId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions", + ":sessionId" + ], + "variable": [ + { + "key": "sessionId" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Internal Server Error. The server hit an unrecoverable system error. The response 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": "X-Sfc-Session", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: bearer", + "key": "Authorization", + "value": "Bearer " + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/sessions/:sessionId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions", + ":sessionId" + ], + "variable": [ + { + "key": "sessionId" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Service 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": "X-Sfc-Session", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: bearer", + "key": "Authorization", + "value": "Bearer " + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/sessions/:sessionId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions", + ":sessionId" + ], + "variable": [ + { + "key": "sessionId" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gateway 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": "X-Sfc-Session", + "value": "" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: bearer", + "key": "Authorization", + "value": "Bearer " + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/sessions/:sessionId", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions", + ":sessionId" + ], + "variable": [ + { + "key": "sessionId" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{sessionId}:refresh-token", + "item": [ + { + "name": "Request new session tokens", + "event": [ + { + "listen": "test", + "script": { + "exec": [ + "", + "var jsonData = pm.response.json();", + "pm.environment.set(\"sessionToken\", jsonData[\"token\"]);", + "pm.environment.set(\"masterToken\", jsonData[\"masterToken\"])", + "pm.environment.set(\"sessionId\", jsonData[\"sessionId\"])", + "" + ], + "type": "text/javascript" + } + } + ], + "request": { + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "value", + "value": "Snowflake Token=\"{{masterToken}}\"", + "type": "string" + }, + { + "key": "key", + "value": "Authorization", + "type": "string" + } + ] + }, + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"sessionToken\": \"{{sessionToken}}\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/sessions/{{sessionId}}:refresh-token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions", + "{{sessionId}}:refresh-token" + ] + }, + "description": "Request new session tokens by providing the master token." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "X-Sfc-Session", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: bearer", + "key": "Authorization", + "value": "Bearer " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"masterToken\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/sessions/{{sessionId}}:refresh-token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions", + "{{sessionId}}:refresh-token" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"token\": \"\",\n \"validityInSeconds\": \"\",\n \"masterToken\": \"\",\n \"masterValidityInSeconds\": \"\",\n \"sessionId\": \"\"\n}" + }, + { + "name": "Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct 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": "X-Sfc-Session", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: bearer", + "key": "Authorization", + "value": "Bearer " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"masterToken\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/sessions/{{sessionId}}:refresh-token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions", + "{{sessionId}}:refresh-token" + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response 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": "X-Sfc-Session", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: bearer", + "key": "Authorization", + "value": "Bearer " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"masterToken\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/sessions/{{sessionId}}:refresh-token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions", + "{{sessionId}}:refresh-token" + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "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": "X-Sfc-Session", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: bearer", + "key": "Authorization", + "value": "Bearer " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"masterToken\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/sessions/{{sessionId}}:refresh-token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions", + "{{sessionId}}:refresh-token" + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Not Found. 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": "X-Sfc-Session", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: bearer", + "key": "Authorization", + "value": "Bearer " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"masterToken\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/sessions/{{sessionId}}:refresh-token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions", + "{{sessionId}}:refresh-token" + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Method Not Allowed. The request method doesn't match 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": "X-Sfc-Session", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: bearer", + "key": "Authorization", + "value": "Bearer " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"masterToken\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/sessions/{{sessionId}}:refresh-token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions", + "{{sessionId}}:refresh-token" + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\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": "X-Sfc-Session", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: bearer", + "key": "Authorization", + "value": "Bearer " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"masterToken\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/sessions/{{sessionId}}:refresh-token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions", + "{{sessionId}}:refresh-token" + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "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": "X-Sfc-Session", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: bearer", + "key": "Authorization", + "value": "Bearer " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"masterToken\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/sessions/{{sessionId}}:refresh-token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions", + "{{sessionId}}:refresh-token" + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Internal Server Error. The server hit an unrecoverable system error. The response 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": "X-Sfc-Session", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: bearer", + "key": "Authorization", + "value": "Bearer " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"masterToken\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/sessions/{{sessionId}}:refresh-token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions", + "{{sessionId}}:refresh-token" + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Service 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": "X-Sfc-Session", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: bearer", + "key": "Authorization", + "value": "Bearer " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"masterToken\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/sessions/{{sessionId}}:refresh-token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions", + "{{sessionId}}:refresh-token" + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gateway 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": "X-Sfc-Session", + "value": "" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: bearer", + "key": "Authorization", + "value": "Bearer " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"masterToken\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/sessions/{{sessionId}}:refresh-token", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions", + "{{sessionId}}:refresh-token" + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "Create a session", + "event": [ + { + "listen": "prerequest", + "script": { + "exec": [ + "" + ], + "type": "text/javascript" + } + }, + { + "listen": "test", + "script": { + "exec": [ + "", + "var jsonData = pm.response.json();", + "pm.environment.set(\"sessionToken\", jsonData[\"token\"]);", + "pm.environment.set(\"masterToken\", jsonData[\"masterToken\"])", + "pm.environment.set(\"sessionId\", jsonData[\"sessionId\"])", + "" + ], + "type": "text/javascript" + } + } + ], + "request": { + "auth": { + "type": "bearer", + "bearer": [ + { + "key": "token", + "value": "{{bearerToken}}", + "type": "string" + } + ] + }, + "method": "POST", + "header": [ + { + "key": "X-Snowflake-Authorization-Token-Type", + "value": "KEYPAIR_JWT" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"roleName\": \"sysadmin\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions" + ] + }, + "description": "Create a session, with keys pairs or Oath authentication methods." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "X-Snowflake-Authorization-Token-Type", + "value": "KEYPAIR_JWT" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: bearer", + "key": "Authorization", + "value": "Bearer " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"roleName\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"token\": \"\",\n \"validityInSeconds\": \"\",\n \"masterToken\": \"\",\n \"masterValidityInSeconds\": \"\",\n \"sessionId\": \"\"\n}" + }, + { + "name": "Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct 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": "X-Snowflake-Authorization-Token-Type", + "value": "KEYPAIR_JWT" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: bearer", + "key": "Authorization", + "value": "Bearer " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"roleName\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions" + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response 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": "X-Snowflake-Authorization-Token-Type", + "value": "KEYPAIR_JWT" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: bearer", + "key": "Authorization", + "value": "Bearer " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"roleName\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions" + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "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": "X-Snowflake-Authorization-Token-Type", + "value": "KEYPAIR_JWT" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: bearer", + "key": "Authorization", + "value": "Bearer " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"roleName\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions" + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Not Found. 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": "X-Snowflake-Authorization-Token-Type", + "value": "KEYPAIR_JWT" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: bearer", + "key": "Authorization", + "value": "Bearer " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"roleName\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions" + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Method Not Allowed. The request method doesn't match 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": "X-Snowflake-Authorization-Token-Type", + "value": "KEYPAIR_JWT" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: bearer", + "key": "Authorization", + "value": "Bearer " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"roleName\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions" + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\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": "X-Snowflake-Authorization-Token-Type", + "value": "KEYPAIR_JWT" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: bearer", + "key": "Authorization", + "value": "Bearer " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"roleName\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions" + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "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": "X-Snowflake-Authorization-Token-Type", + "value": "KEYPAIR_JWT" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: bearer", + "key": "Authorization", + "value": "Bearer " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"roleName\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions" + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Internal Server Error. The server hit an unrecoverable system error. The response 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": "X-Snowflake-Authorization-Token-Type", + "value": "KEYPAIR_JWT" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: bearer", + "key": "Authorization", + "value": "Bearer " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"roleName\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions" + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Service 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": "X-Snowflake-Authorization-Token-Type", + "value": "KEYPAIR_JWT" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: bearer", + "key": "Authorization", + "value": "Bearer " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"roleName\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions" + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gateway 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": "X-Snowflake-Authorization-Token-Type", + "value": "KEYPAIR_JWT" + }, + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + }, + { + "description": "Added as a part of security scheme: bearer", + "key": "Authorization", + "value": "Bearer " + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"roleName\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/sessions", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "sessions" + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\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": "sessionId", + "value": "" + } + ] +} \ No newline at end of file diff --git a/collection/private-preview/2023-11-13-private-preview/Snowflake Tasks API.postman_collection.json b/collection/private-preview/2023-11-13-private-preview/Snowflake Tasks API.postman_collection.json new file mode 100644 index 0000000..62beadb --- /dev/null +++ b/collection/private-preview/2023-11-13-private-preview/Snowflake Tasks API.postman_collection.json @@ -0,0 +1,7237 @@ +{ + "info": { + "_postman_id": "1af61c08-a610-4705-b19c-4760742b5dca", + "name": "Snowflake Tasks API", + "description": "The Snowflake Tasks API is a REST API that you can use to access, update, and perform certain actions on Task resources in a Snowflake database.\n\nContact Support:\n Name: Snowflake, Inc.\n Email: support@snowflake.com", + "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", + "_exporter_id": "28868798", + "_collection_link": "https://snowflake.postman.co/workspace/SnowApi-Demo~576e3337-09c5-4d42-a068-1fb91ebec0b9/collection/28868798-1af61c08-a610-4705-b19c-4760742b5dca?action=share&source=collection_link&creator=28868798" + }, + "item": [ + { + "name": "api", + "item": [ + { + "name": "v2", + "item": [ + { + "name": "databases", + "item": [ + { + "name": "{database}", + "item": [ + { + "name": "schemas", + "item": [ + { + "name": "{schema}", + "item": [ + { + "name": "tasks", + "item": [ + { + "name": "{name}", + "item": [ + { + "name": "dependents", + "item": [ + { + "name": "Fetch the dependent tasks of a task", + "request": { + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "value", + "value": "Snowflake Token=\"{{sessionToken}}\"", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + }, + { + "key": "key", + "value": "Authorization", + "type": "string" + } + ] + }, + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/dependents", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "dependents" + ], + "variable": [ + { + "key": "database", + "value": "{{database}}", + "description": "(Required) " + }, + { + "key": "schema", + "value": "{{schema}}", + "description": "(Required) " + }, + { + "key": "name", + "value": "{{task_name}}", + "description": "(Required) " + } + ] + }, + "description": "This operation returns a list of the dependent tasks of the task with identifier {name}." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/dependents", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "dependents" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"Pw$SP9KZSr\",\n \"definition\": \"\",\n \"warehouse\": \"WBzQP_2\",\n \"schedule\": {\n \"minutes\": \"\"\n },\n \"comment\": \"\",\n \"config\": {\n \"Ut_293\": -93287673.26920931,\n \"cupidatatf0d\": \"qui fugiat in \",\n \"quis1\": \"aliqua enim eiusmod consequat cupidatat\",\n \"Ut_0\": \"incididunt ullamco dolore in commodo\"\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 \"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 {\n \"name\": \"gTq9T\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"\\\"\\\":((\\\"\\\"4\\\"\",\n \"schedule\": {\n \"minutes\": \"\"\n },\n \"comment\": \"\",\n \"config\": {\n \"culpa182\": -36841827.82457221,\n \"consectetur_f2\": \"Ut anim\",\n \"officia_aa\": -66193433.51332709\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 \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n }\n]" + }, + { + "name": "Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct request payload. The response body may include the error code and message indicating the actual cause. The application must reconstruct the r", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/dependents", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "dependents" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response body may include the error code and message indicating the actual cause, e.g., expired, invalid token. The application must obtain a", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/dependents", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "dependents" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/dependents", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "dependents" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/dependents", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "dependents" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Method Not Allowed. The request method doesn't match the supported API. This happens, for example, if the application calls the API with GET method but the endpoint accepts only POST.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/dependents", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "dependents" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/dependents", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "dependents" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Internal Server Error. The server hit an unrecoverable system error. The response body may include the error code and message for further guidance. The application owner may need to reach out the customer support.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/dependents", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "dependents" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/dependents", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "dependents" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/dependents", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "dependents" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\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": { + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "value", + "value": "Snowflake Token=\"{{sessionToken}}\"", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + }, + { + "key": "key", + "value": "Authorization", + "type": "string" + } + ] + }, + "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": "{{database}}", + "description": "(Required) " + }, + { + "key": "schema", + "value": "{{schema}}", + "description": "(Required) " + }, + { + "key": "name", + "value": "{{task_name}}", + "description": "(Required) " + } + ] + }, + "description": "This function returns details for graph runs that are currently executing or are next scheduled to run within the next 8 days." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current_graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "[\n {\n \"root_task_name\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"state\": \"EXECUTING\",\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\": \"EXECUTING\",\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": "Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct request payload. The response body may include the error code and message indicating the actual cause. The application must reconstruct the r", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current_graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response body may include the error code and message indicating the actual cause, e.g., expired, invalid token. The application must obtain a", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current_graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current_graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current_graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Method Not Allowed. The request method doesn't match the supported API. This happens, for example, if the application calls the API with GET method but the endpoint accepts only POST.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current_graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current_graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Internal Server Error. The server hit an unrecoverable system error. The response body may include the error code and message for further guidance. The application owner may need to reach out the customer support.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current_graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current_graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/current_graphs?resultLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "current_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "complete_graphs", + "item": [ + { + "name": "Get the graph runs that are completed for the task.", + "request": { + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "value", + "value": "Snowflake Token=\"{{sessionToken}}\"", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + }, + { + "key": "key", + "value": "Authorization", + "type": "string" + } + ] + }, + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete_graphs?resultLimit=1000&errorOnly=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "1000", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "false", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database", + "value": "{{database}}", + "description": "(Required) " + }, + { + "key": "schema", + "value": "{{schema}}", + "description": "(Required) " + }, + { + "key": "name", + "value": "{{task_name}}", + "description": "(Required) " + } + ] + }, + "description": "This function returns details for graph runs that are completed." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete_graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "[\n {\n \"root_task_name\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\",\n \"state\": \"EXECUTING\",\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\": \"EXECUTING\",\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": "Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct request payload. The response body may include the error code and message indicating the actual cause. The application must reconstruct the r", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete_graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response body may include the error code and message indicating the actual cause, e.g., expired, invalid token. The application must obtain a", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete_graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete_graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete_graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Method Not Allowed. The request method doesn't match the supported API. This happens, for example, if the application calls the API with GET method but the endpoint accepts only POST.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete_graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete_graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Internal Server Error. The server hit an unrecoverable system error. The response body may include the error code and message for further guidance. The application owner may need to reach out the customer support.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete_graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete_graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name/complete_graphs?resultLimit=&errorOnly=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name", + "complete_graphs" + ], + "query": [ + { + "key": "resultLimit", + "value": "", + "description": "Number of results to return, at most. Default is 1000, valid range is 1 to 10000." + }, + { + "key": "errorOnly", + "value": "", + "description": "Whether to only return results for tasks runs that have failed. Default is false." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "Fetch a task", + "request": { + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "value", + "value": "Snowflake Token=\"{{sessionToken}}\"", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + }, + { + "key": "key", + "value": "Authorization", + "type": "string" + } + ] + }, + "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": "{{database}}", + "description": "(Required) " + }, + { + "key": "schema", + "value": "{{schema}}", + "description": "(Required) " + }, + { + "key": "name", + "value": "{{task_name}}", + "description": "(Required) " + } + ] + }, + "description": "Fetch a task using the describe command output." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"name\": \"mga_vVk\",\n \"definition\": \"\",\n \"warehouse\": \"sYG7\",\n \"schedule\": {\n \"minutes\": \"\"\n },\n \"comment\": \"\",\n \"config\": {\n \"dolor_\": \"eiusmod dolor consequat sed\"\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 \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}" + }, + { + "name": "Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct request payload. The response body may include the error code and message indicating the actual cause. The application must reconstruct the r", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response body may include the error code and message indicating the actual cause, e.g., expired, invalid token. The application must obtain a", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Method Not Allowed. The request method doesn't match the supported API. This happens, for example, if the application calls the API with GET method but the endpoint accepts only POST.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Internal Server Error. The server hit an unrecoverable system error. The response body may include the error code and message for further guidance. The application owner may need to reach out the customer support.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "Create a (or alter an existing) task", + "request": { + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "value", + "value": "Snowflake Token=\"{{sessionToken}}\"", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + }, + { + "key": "key", + "value": "Authorization", + "type": "string" + } + ] + }, + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"{{task_name}}\",\n \"warehouse\": \"{{warehouse}}\",\n \"definition\": \"select 1\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name?createMode=orReplace", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "query": [ + { + "key": "createMode", + "value": "orReplace" + } + ], + "variable": [ + { + "key": "database", + "value": "{{database}}", + "description": "(Required) " + }, + { + "key": "schema", + "value": "{{schema}}", + "description": "(Required) " + }, + { + "key": "name", + "value": "{{task_name}}", + "description": "(Required) " + } + ] + }, + "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", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"mga_vVk\",\n \"definition\": \"\",\n \"warehouse\": \"sYG7\",\n \"schedule\": {\n \"minutes\": \"\"\n },\n \"comment\": \"\",\n \"config\": {\n \"dolor_\": \"eiusmod dolor consequat sed\"\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 \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct request payload. The response body may include the error code and message indicating the actual cause. The application must reconstruct the r", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"mga_vVk\",\n \"definition\": \"\",\n \"warehouse\": \"sYG7\",\n \"schedule\": {\n \"minutes\": \"\"\n },\n \"comment\": \"\",\n \"config\": {\n \"dolor_\": \"eiusmod dolor consequat sed\"\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 \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response body may include the error code and message indicating the actual cause, e.g., expired, invalid token. The application must obtain a", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"mga_vVk\",\n \"definition\": \"\",\n \"warehouse\": \"sYG7\",\n \"schedule\": {\n \"minutes\": \"\"\n },\n \"comment\": \"\",\n \"config\": {\n \"dolor_\": \"eiusmod dolor consequat sed\"\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 \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"mga_vVk\",\n \"definition\": \"\",\n \"warehouse\": \"sYG7\",\n \"schedule\": {\n \"minutes\": \"\"\n },\n \"comment\": \"\",\n \"config\": {\n \"dolor_\": \"eiusmod dolor consequat sed\"\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 \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"mga_vVk\",\n \"definition\": \"\",\n \"warehouse\": \"sYG7\",\n \"schedule\": {\n \"minutes\": \"\"\n },\n \"comment\": \"\",\n \"config\": {\n \"dolor_\": \"eiusmod dolor consequat sed\"\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 \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Method Not Allowed. The request method doesn't match the supported API. This happens, for example, if the application calls the API with GET method but the endpoint accepts only POST.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"mga_vVk\",\n \"definition\": \"\",\n \"warehouse\": \"sYG7\",\n \"schedule\": {\n \"minutes\": \"\"\n },\n \"comment\": \"\",\n \"config\": {\n \"dolor_\": \"eiusmod dolor consequat sed\"\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 \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"mga_vVk\",\n \"definition\": \"\",\n \"warehouse\": \"sYG7\",\n \"schedule\": {\n \"minutes\": \"\"\n },\n \"comment\": \"\",\n \"config\": {\n \"dolor_\": \"eiusmod dolor consequat sed\"\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 \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Internal Server Error. The server hit an unrecoverable system error. The response body may include the error code and message for further guidance. The application owner may need to reach out the customer support.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"mga_vVk\",\n \"definition\": \"\",\n \"warehouse\": \"sYG7\",\n \"schedule\": {\n \"minutes\": \"\"\n },\n \"comment\": \"\",\n \"config\": {\n \"dolor_\": \"eiusmod dolor consequat sed\"\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 \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"mga_vVk\",\n \"definition\": \"\",\n \"warehouse\": \"sYG7\",\n \"schedule\": {\n \"minutes\": \"\"\n },\n \"comment\": \"\",\n \"config\": {\n \"dolor_\": \"eiusmod dolor consequat sed\"\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 \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "PUT", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"mga_vVk\",\n \"definition\": \"\",\n \"warehouse\": \"sYG7\",\n \"schedule\": {\n \"minutes\": \"\"\n },\n \"comment\": \"\",\n \"config\": {\n \"dolor_\": \"eiusmod dolor consequat sed\"\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 \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "Delete a task", + "request": { + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "value", + "value": "Snowflake Token=\"{{sessionToken}}\"", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + }, + { + "key": "key", + "value": "Authorization", + "type": "string" + } + ] + }, + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name?ifExists=true", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "true" + } + ], + "variable": [ + { + "key": "database", + "value": "{{database}}", + "description": "(Required) " + }, + { + "key": "schema", + "value": "{{schema}}", + "description": "(Required) " + }, + { + "key": "name", + "value": "{{task_name}}", + "description": "(Required) " + } + ] + }, + "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", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct request payload. The response body may include the error code and message indicating the actual cause. The application must reconstruct the r", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response body may include the error code and message indicating the actual cause, e.g., expired, invalid token. The application must obtain a", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Method Not Allowed. The request method doesn't match the supported API. This happens, for example, if the application calls the API with GET method but the endpoint accepts only POST.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Internal Server Error. The server hit an unrecoverable system error. The response body may include the error code and message for further guidance. The application owner may need to reach out the customer support.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "DELETE", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/:name?ifExists=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + ":name" + ], + "query": [ + { + "key": "ifExists", + "value": "false" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + }, + { + "key": "name" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:execute", + "item": [ + { + "name": "Execute a task object.", + "request": { + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "value", + "value": "Snowflake Token=\"{{sessionToken}}\"", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + }, + { + "key": "key", + "value": "Authorization", + "type": "string" + } + ] + }, + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "retryLast", + "value": "false", + "description": "Retry the last failed run of the DAG." + } + ], + "variable": [ + { + "key": "database", + "value": "{{database}}", + "description": "(Required) " + }, + { + "key": "schema", + "value": "{{schema}}", + "description": "(Required) " + } + ] + }, + "description": "Execute a task -- this is equivalent to EXECUTE IMMEDIATE." + }, + "response": [ + { + "name": "Successful", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "retryLast", + "value": "false", + "description": "Retry the last failed run of the DAG." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct request payload. The response body may include the error code and message indicating the actual cause. The application must reconstruct the r", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "retryLast", + "value": "false", + "description": "Retry the last failed run of the DAG." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response body may include the error code and message indicating the actual cause, e.g., expired, invalid token. The application must obtain a", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "retryLast", + "value": "false", + "description": "Retry the last failed run of the DAG." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "retryLast", + "value": "false", + "description": "Retry the last failed run of the DAG." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "retryLast", + "value": "false", + "description": "Retry the last failed run of the DAG." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Method Not Allowed. The request method doesn't match the supported API. This happens, for example, if the application calls the API with GET method but the endpoint accepts only POST.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "retryLast", + "value": "false", + "description": "Retry the last failed run of the DAG." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "retryLast", + "value": "false", + "description": "Retry the last failed run of the DAG." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Internal Server Error. The server hit an unrecoverable system error. The response body may include the error code and message for further guidance. The application owner may need to reach out the customer support.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "retryLast", + "value": "false", + "description": "Retry the last failed run of the DAG." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "retryLast", + "value": "false", + "description": "Retry the last failed run of the DAG." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:execute?retryLast=false", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:execute" + ], + "query": [ + { + "key": "retryLast", + "value": "false", + "description": "Retry the last failed run of the DAG." + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:resume", + "item": [ + { + "name": "Resume a suspended task.", + "request": { + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "value", + "value": "Snowflake Token=\"{{sessionToken}}\"", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + }, + { + "key": "key", + "value": "Authorization", + "type": "string" + } + ] + }, + "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": "{{database}}", + "description": "(Required) " + }, + { + "key": "schema", + "value": "{{schema}}", + "description": "(Required) " + } + ] + }, + "description": "Resumes a suspended task object. This is equivalento an ALTER TASK ... RESUME." + }, + "response": [ + { + "name": "Successful", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:resume" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct request payload. The response body may include the error code and message indicating the actual cause. The application must reconstruct the r", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:resume" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response body may include the error code and message indicating the actual cause, e.g., expired, invalid token. The application must obtain a", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:resume" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:resume" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:resume" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Method Not Allowed. The request method doesn't match the supported API. This happens, for example, if the application calls the API with GET method but the endpoint accepts only POST.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:resume" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:resume" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Internal Server Error. The server hit an unrecoverable system error. The response body may include the error code and message for further guidance. The application owner may need to reach out the customer support.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:resume" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:resume" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:resume", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:resume" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "{name}:suspend", + "item": [ + { + "name": "Suspends a running task.", + "request": { + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "value", + "value": "Snowflake Token=\"{{sessionToken}}\"", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + }, + { + "key": "key", + "value": "Authorization", + "type": "string" + } + ] + }, + "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": "{{database}}", + "description": "(Required) " + }, + { + "key": "schema", + "value": "{{schema}}", + "description": "(Required) " + } + ] + }, + "description": "Suspends a running task. This is equivalent to an ALTER TASK ... SUSPEND." + }, + "response": [ + { + "name": "Successful", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:suspend" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct request payload. The response body may include the error code and message indicating the actual cause. The application must reconstruct the r", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:suspend" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response body may include the error code and message indicating the actual cause, e.g., expired, invalid token. The application must obtain a", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:suspend" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:suspend" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:suspend" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Method Not Allowed. The request method doesn't match the supported API. This happens, for example, if the application calls the API with GET method but the endpoint accepts only POST.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:suspend" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:suspend" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Internal Server Error. The server hit an unrecoverable system error. The response body may include the error code and message for further guidance. The application owner may need to reach out the customer support.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:suspend" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:suspend" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks/{{name}}:suspend", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks", + "{{name}}:suspend" + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + }, + { + "name": "List tasks", + "request": { + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "value", + "value": "Snowflake Token=\"{{sessionToken}}\"", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + }, + { + "key": "key", + "value": "Authorization", + "type": "string" + } + ] + }, + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "rootOnly", + "value": "false", + "disabled": true + }, + { + "key": "like", + "value": "%taskName%", + "disabled": true + }, + { + "key": "startsWith", + "value": "task%", + "disabled": true + }, + { + "key": "showLimit", + "value": "10", + "disabled": true + } + ], + "variable": [ + { + "key": "database", + "value": "{{database}}", + "description": "(Required) " + }, + { + "key": "schema", + "value": "{{schema}}", + "description": "(Required) " + } + ] + }, + "description": "Lists tasks under the database and schema, with show options as query parameters." + }, + "response": [ + { + "name": "successful", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?rootOnly=false&like=&startsWith=&showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "rootOnly", + "value": "false" + }, + { + "key": "like", + "value": "" + }, + { + "key": "startsWith", + "value": "" + }, + { + "key": "showLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "[\n {\n \"name\": \"Pw$SP9KZSr\",\n \"definition\": \"\",\n \"warehouse\": \"WBzQP_2\",\n \"schedule\": {\n \"minutes\": \"\"\n },\n \"comment\": \"\",\n \"config\": {\n \"Ut_293\": -93287673.26920931,\n \"cupidatatf0d\": \"qui fugiat in \",\n \"quis1\": \"aliqua enim eiusmod consequat cupidatat\",\n \"Ut_0\": \"incididunt ullamco dolore in commodo\"\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 \"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 {\n \"name\": \"gTq9T\",\n \"definition\": \"\",\n \"warehouse\": \"\\\"\\\"\\\":((\\\"\\\"4\\\"\",\n \"schedule\": {\n \"minutes\": \"\"\n },\n \"comment\": \"\",\n \"config\": {\n \"culpa182\": -36841827.82457221,\n \"consectetur_f2\": \"Ut anim\",\n \"officia_aa\": -66193433.51332709\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 \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n }\n]" + }, + { + "name": "Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct request payload. The response body may include the error code and message indicating the actual cause. The application must reconstruct the r", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?rootOnly=false&like=&startsWith=&showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "rootOnly", + "value": "false" + }, + { + "key": "like", + "value": "" + }, + { + "key": "startsWith", + "value": "" + }, + { + "key": "showLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response body may include the error code and message indicating the actual cause, e.g., expired, invalid token. The application must obtain a", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?rootOnly=false&like=&startsWith=&showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "rootOnly", + "value": "false" + }, + { + "key": "like", + "value": "" + }, + { + "key": "startsWith", + "value": "" + }, + { + "key": "showLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?rootOnly=false&like=&startsWith=&showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "rootOnly", + "value": "false" + }, + { + "key": "like", + "value": "" + }, + { + "key": "startsWith", + "value": "" + }, + { + "key": "showLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?rootOnly=false&like=&startsWith=&showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "rootOnly", + "value": "false" + }, + { + "key": "like", + "value": "" + }, + { + "key": "startsWith", + "value": "" + }, + { + "key": "showLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Method Not Allowed. The request method doesn't match the supported API. This happens, for example, if the application calls the API with GET method but the endpoint accepts only POST.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?rootOnly=false&like=&startsWith=&showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "rootOnly", + "value": "false" + }, + { + "key": "like", + "value": "" + }, + { + "key": "startsWith", + "value": "" + }, + { + "key": "showLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Conflict. The requested operation could not be performed due to a conflicting state that could not be resolved. This usually happens when a CREATE request was performed when there is a pre-existing resource with the same name, and also without one of the ", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?rootOnly=false&like=&startsWith=&showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "rootOnly", + "value": "false" + }, + { + "key": "like", + "value": "" + }, + { + "key": "startsWith", + "value": "" + }, + { + "key": "showLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?rootOnly=false&like=&startsWith=&showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "rootOnly", + "value": "false" + }, + { + "key": "like", + "value": "" + }, + { + "key": "startsWith", + "value": "" + }, + { + "key": "showLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Internal Server Error. The server hit an unrecoverable system error. The response body may include the error code and message for further guidance. The application owner may need to reach out the customer support.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?rootOnly=false&like=&startsWith=&showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "rootOnly", + "value": "false" + }, + { + "key": "like", + "value": "" + }, + { + "key": "startsWith", + "value": "" + }, + { + "key": "showLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?rootOnly=false&like=&startsWith=&showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "rootOnly", + "value": "false" + }, + { + "key": "like", + "value": "" + }, + { + "key": "startsWith", + "value": "" + }, + { + "key": "showLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", + "originalRequest": { + "method": "GET", + "header": [ + { + "key": "Accept", + "value": "application/json" + } + ], + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?rootOnly=false&like=&startsWith=&showLimit=", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "rootOnly", + "value": "false" + }, + { + "key": "like", + "value": "" + }, + { + "key": "startsWith", + "value": "" + }, + { + "key": "showLimit", + "value": "" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + }, + { + "name": "Create a task", + "request": { + "auth": { + "type": "apikey", + "apikey": [ + { + "key": "value", + "value": "Snowflake Token=\"{{sessionToken}}\"", + "type": "string" + }, + { + "key": "in", + "value": "header", + "type": "string" + }, + { + "key": "key", + "value": "Authorization", + "type": "string" + } + ] + }, + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"{{task_name}}\",\n \"definition\": \"select 1\",\n \"warehouse\": \"{{warehouse}}\",\n \"predecessors\": [\n \"task1\",\n \"task2\",\n \"task3\"\n ],\n \"user_task_timeout_ms\": 10,\n \"condition\": \"SYSTEM$GET_PREDECESSOR_RETURN_VALUE('test_task') != 'VALIDATION'\",\n \"allow_overlapping_execution\": false,\n \"database_name\": \"{{database}}\",\n \"schema_name\": \"{{schema}}\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?createMode=orReplace", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "createMode", + "value": "orReplace" + } + ], + "variable": [ + { + "key": "database", + "value": "{{database}}", + "description": "(Required) " + }, + { + "key": "schema", + "value": "{{schema}}", + "description": "(Required) " + } + ] + }, + "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", + "originalRequest": { + "method": "POST", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "Accept", + "value": "application/json" + } + ], + "body": { + "mode": "raw", + "raw": "{\n \"name\": \"mga_vVk\",\n \"definition\": \"\",\n \"warehouse\": \"sYG7\",\n \"schedule\": {\n \"minutes\": \"\"\n },\n \"comment\": \"\",\n \"config\": {\n \"dolor_\": \"eiusmod dolor consequat sed\"\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 \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"status\": \"\"\n}" + }, + { + "name": "Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct 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\": \"mga_vVk\",\n \"definition\": \"\",\n \"warehouse\": \"sYG7\",\n \"schedule\": {\n \"minutes\": \"\"\n },\n \"comment\": \"\",\n \"config\": {\n \"dolor_\": \"eiusmod dolor consequat sed\"\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 \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Bad Request", + "code": 400, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response 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\": \"mga_vVk\",\n \"definition\": \"\",\n \"warehouse\": \"sYG7\",\n \"schedule\": {\n \"minutes\": \"\"\n },\n \"comment\": \"\",\n \"config\": {\n \"dolor_\": \"eiusmod dolor consequat sed\"\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 \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Unauthorized", + "code": 401, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "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\": \"mga_vVk\",\n \"definition\": \"\",\n \"warehouse\": \"sYG7\",\n \"schedule\": {\n \"minutes\": \"\"\n },\n \"comment\": \"\",\n \"config\": {\n \"dolor_\": \"eiusmod dolor consequat sed\"\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 \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Forbidden", + "code": 403, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Not Found. 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\": \"mga_vVk\",\n \"definition\": \"\",\n \"warehouse\": \"sYG7\",\n \"schedule\": {\n \"minutes\": \"\"\n },\n \"comment\": \"\",\n \"config\": {\n \"dolor_\": \"eiusmod dolor consequat sed\"\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 \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Not Found", + "code": 404, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Method Not Allowed. The request method doesn't match 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\": \"mga_vVk\",\n \"definition\": \"\",\n \"warehouse\": \"sYG7\",\n \"schedule\": {\n \"minutes\": \"\"\n },\n \"comment\": \"\",\n \"config\": {\n \"dolor_\": \"eiusmod dolor consequat sed\"\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 \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Method Not Allowed", + "code": 405, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\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\": \"mga_vVk\",\n \"definition\": \"\",\n \"warehouse\": \"sYG7\",\n \"schedule\": {\n \"minutes\": \"\"\n },\n \"comment\": \"\",\n \"config\": {\n \"dolor_\": \"eiusmod dolor consequat sed\"\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 \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Conflict", + "code": 409, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "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\": \"mga_vVk\",\n \"definition\": \"\",\n \"warehouse\": \"sYG7\",\n \"schedule\": {\n \"minutes\": \"\"\n },\n \"comment\": \"\",\n \"config\": {\n \"dolor_\": \"eiusmod dolor consequat sed\"\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 \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Too Many Requests", + "code": 429, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Internal Server Error. The server hit an unrecoverable system error. The response 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\": \"mga_vVk\",\n \"definition\": \"\",\n \"warehouse\": \"sYG7\",\n \"schedule\": {\n \"minutes\": \"\"\n },\n \"comment\": \"\",\n \"config\": {\n \"dolor_\": \"eiusmod dolor consequat sed\"\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 \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Internal Server Error", + "code": 500, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Service 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\": \"mga_vVk\",\n \"definition\": \"\",\n \"warehouse\": \"sYG7\",\n \"schedule\": {\n \"minutes\": \"\"\n },\n \"comment\": \"\",\n \"config\": {\n \"dolor_\": \"eiusmod dolor consequat sed\"\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 \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Service Unavailable", + "code": 503, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + }, + { + "name": "Gateway 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\": \"mga_vVk\",\n \"definition\": \"\",\n \"warehouse\": \"sYG7\",\n \"schedule\": {\n \"minutes\": \"\"\n },\n \"comment\": \"\",\n \"config\": {\n \"dolor_\": \"eiusmod dolor consequat sed\"\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 \"created_on\": \"\",\n \"id\": \"\",\n \"owner\": \"\",\n \"owner_role_type\": \"\",\n \"state\": \"suspended\",\n \"last_committed_on\": \"\",\n \"last_suspended_on\": \"\",\n \"database_name\": \"\",\n \"schema_name\": \"\"\n}", + "options": { + "raw": { + "headerFamily": "json", + "language": "json" + } + } + }, + "url": { + "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/tasks?createMode=errorIfExists", + "host": [ + "{{baseUrl}}" + ], + "path": [ + "api", + "v2", + "databases", + ":database", + "schemas", + ":schema", + "tasks" + ], + "query": [ + { + "key": "createMode", + "value": "errorIfExists" + } + ], + "variable": [ + { + "key": "database" + }, + { + "key": "schema" + } + ] + } + }, + "status": "Gateway Timeout", + "code": 504, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + } + ], + "cookie": [], + "body": "{\n \"message\": \"\",\n \"error_code\": \"\",\n \"request_id\": \"\"\n}" + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ] + } + ], + "variable": [ + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com" + }, + { + "key": "name", + "value": "c" + }, + { + "key": "name", + "value": "c" + }, + { + "key": "name", + "value": "c" + } + ] +} \ No newline at end of file diff --git a/collection/private-preview/2023-11-13-private-preview/TestEnv.postman_environment.json b/collection/private-preview/2023-11-13-private-preview/TestEnv.postman_environment.json new file mode 100644 index 0000000..a748371 --- /dev/null +++ b/collection/private-preview/2023-11-13-private-preview/TestEnv.postman_environment.json @@ -0,0 +1,75 @@ +{ + "id": "53c4683e-0b55-435c-923f-35d54b971019", + "name": "TestEnv", + "values": [ + { + "key": "bearerToken", + "value": "", + "type": "any", + "enabled": true + }, + { + "key": "baseUrl", + "value": "https://org-account.snowflakecomputing.com", + "type": "default", + "enabled": true + }, + { + "key": "sessionToken", + "value": "", + "type": "any", + "enabled": true + }, + { + "key": "masterToken", + "value": "", + "type": "any", + "enabled": true + }, + { + "key": "sessionId", + "value": "", + "type": "any", + "enabled": true + }, + { + "key": "database", + "value": "test_db", + "type": "default", + "enabled": true + }, + { + "key": "schema", + "value": "test_sc", + "type": "default", + "enabled": true + }, + { + "key": "warehouse", + "value": "test_wh", + "type": "default", + "enabled": true + }, + { + "key": "task_name", + "value": "test_task", + "type": "default", + "enabled": true + }, + { + "key": "image_repository_name", + "value": "test_image_repository", + "type": "default", + "enabled": true + }, + { + "key": "compute_pool_name", + "value": "test_compute_pool", + "type": "default", + "enabled": true + } + ], + "_postman_variable_scope": "environment", + "_postman_exported_at": "2023-11-14T20:53:33.869Z", + "_postman_exported_using": "Postman/10.20.0" +} \ No newline at end of file diff --git a/specification/private-preview/2023-11-13-private-preview/common.yaml b/specification/private-preview/2023-11-13-private-preview/common.yaml new file mode 100644 index 0000000..7ed12a6 --- /dev/null +++ b/specification/private-preview/2023-11-13-private-preview/common.yaml @@ -0,0 +1,310 @@ +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 + pattern: '^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$' + ErrorResponse: + type: object + properties: + message: + type: string + description: "Error message returned by server" + error_code: + type: string + description: "Error code" + 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 response returned by server" + properties: + status: + type: string + description: "Message returned by server" + example: + status: "Request successfully completed" + Clone: + type: object + description: When cloning an obejct we need the source's name and a point of time that we want to clone at. + properties: + source: + $ref: './common.yaml#/components/schemas/Identifier' + point_of_time: + $ref: '#/components/schemas/PointOfTime' + required: + - "source" + PointOfTime: + type: object + required: + - point_of_time_type + properties: + point_of_time_type: + type: string + reference: + type: string + description: The relation to the point of time. + At the time of writing at and before are supported. + when: + type: string + description: The actual description of the point of time. + discriminator: + propertyName: point_of_time_type + mapping: + timestamp: PointOfTimeTimestamp + offset: PointOfTimeOffset + statement: PointOfTimeStatement + PointOfTimeTimestamp: + description: A point of time that is identified by a timestamp. + allOf: + - $ref: '#/components/schemas/PointOfTime' + PointOfTimeOffset: + description: A point of time that is identified by an offset in reference to right now. + allOf: + - $ref: '#/components/schemas/PointOfTime' + PointOfTimeStatement: + description: A point of time that is identified by when a statement was executed. + allOf: + - $ref: '#/components/schemas/PointOfTime' + parameters: + database: + name: database + required: true + in: 'path' + schema: + example: TEST_DB + $ref: './common.yaml#/components/schemas/Identifier' + schema: + name: schema + required: true + in: 'path' + schema: + example: TEST_SCHEMA + $ref: './common.yaml#/components/schemas/Identifier' + name: + name: name + required: true + in: 'path' + schema: + example: TEST_NAME + $ref: './common.yaml#/components/schemas/Identifier' + tag: + name: 'tag' + in: 'query' + schema: + type: object + example: TEST_TAG + additionalProperties: true + createMode: + name: 'createMode' + in: 'query' + schema: + type: string + enum: [errorIfExists, orReplace, ifNotExists] + example: errorIfExists + default: errorIfExists + ifExists: + name: 'ifExists' + in: 'query' + schema: + type: boolean + example: false + default: false + like: + name: 'like' + in: 'query' + schema: + type: string + example: "test_%" + startsWith: + name: 'startsWith' + in: 'query' + schema: + type: string + example: "test" + rootOnly: + name: 'rootOnly' + in: 'query' + schema: + type: boolean + example: false + default: false + showLimit: + name: 'showLimit' + in: 'query' + schema: + type: integer + example: 10 + fromName: + name: 'fromName' + in: 'query' + schema: + type: string + example: "from_test" + sessionId: + name: 'sessionId' + required: true + in: path + schema: + type: integer + format: uuid + example: 524514326772799 + content-type: + name: 'Content-Type' + in: header + schema: + type: string + enum: ['application/json'] + accept: + name: 'Accept' + in: header + schema: + type: string + enum: ['application/json'] + x-snowflake-authorization-token-type: + name: 'X-Snowflake-Authorization-Token-Type' + in: header + schema: + type: string + enum: ['KEYPAIR_JWT'] + x-sfc-session: + name: 'X-Sfc-Session' + in: header + required: false + schema: + type: string + description: Snowflake Session Token + example: "ver:3-hint:1000-ABCD=" + 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 authn JWT. + ExternalOAuth: + type: http + scheme: bearer + bearerFormat: JWT + description: Configure External Oauth with Snowflake (refer to docs). Set X-Snowflake-Authorization-Token-Type to OAUTH and set the Token to auth token received from the external Auth server. + snowflakeOAuth: + type: oauth2 + flows: + implicit: + authorizationUrl: /oauth/authorize + scopes: {} + responses: + '200SuccessResponse': + description: Successful + content: + application/json: + schema: + $ref: '#/components/schemas/SuccessResponse' + + '201SuccessCreatedResponse': + description: Successfully create new resource on server. + content: + application/json: + schema: + $ref: '#/components/schemas/SuccessResponse' + + '202SuccessAcceptedResponse': + description: Successfully accept the request, but it is not completed yet. + content: + application/json: + schema: + $ref: '#/components/schemas/SuccessResponse' + + '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. + 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. + 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. + 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. + 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. + 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. + 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. + 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. + 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. + 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. + 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. + 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. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + + security: + - keyPair: [] + - ExternalOAuth: [] + - snowflakeOAuth: [] diff --git a/specification/private-preview/2023-11-13-private-preview/compute-pools.yaml b/specification/private-preview/2023-11-13-private-preview/compute-pools.yaml new file mode 100644 index 0000000..1a885ea --- /dev/null +++ b/specification/private-preview/2023-11-13-private-preview/compute-pools.yaml @@ -0,0 +1,307 @@ +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 certain actions on Compute Pool resources. + contact: + name: Snowflake, Inc. + url: https://snowflake.com + email: support@snowflake.com +paths: + /api/v2/compute-pools: + get: + summary: List compute pools + tags: + - compute-pool + description: Lists the compute pools under the account. + operationId: fetchComputePools + parameters: + - $ref: 'common.yaml#/components/parameters/like' + - $ref: 'common.yaml#/components/parameters/startsWith' + - $ref: 'common.yaml#/components/parameters/showLimit' + responses: + '200': + description: successful + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ComputePool' + '400': + $ref: 'common.yaml#/components/responses/400BadRequest' + '401': + $ref: 'common.yaml#/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' + post: + summary: Create a compute pool + tags: + - compute-pool + description: Create 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' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/ComputePool' + responses: + '200': + $ref: 'common.yaml#/components/responses/200SuccessResponse' + '400': + $ref: 'common.yaml#/components/responses/400BadRequest' + '401': + $ref: 'common.yaml#/components/responses/401Unauthorized' + '403': + $ref: 'common.yaml#/components/responses/403Forbidden' + '404': + $ref: 'common.yaml#/components/responses/404NotFound' + '405': + $ref: 'common.yaml#/components/responses/405MethodNotAllowed' + '409': + $ref: 'common.yaml#/components/responses/409Conflict' + '500': + $ref: 'common.yaml#/components/responses/500InternalServerError' + '503': + $ref: 'common.yaml#/components/responses/503ServiceUnavailable' + '504': + $ref: 'common.yaml#/components/responses/504GatewayTimeout' + /api/v2/compute-pools/{name}: + get: + summary: Fetch a compute pool. + tags: + - compute-pool + description: Fetch a compute pool using the SHOW command output. + operationId: fetchComputePool + parameters: + - $ref: 'common.yaml#/components/parameters/name' + responses: + '200': + description: successful + content: + application/json: + schema: + $ref: '#/components/schemas/ComputePool' + '400': + $ref: 'common.yaml#/components/responses/400BadRequest' + '401': + $ref: 'common.yaml#/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: Delete a compute pool + tags: + - compute-pool + description: Delete a compute pool with the given name. If ifExists is used, the operation will + succeed even if the object does not exist. Otherwise, there will be a 404 failure + if the drop is unsuccessful. + operationId: deleteComputePool + responses: + '200': + $ref: 'common.yaml#/components/responses/200SuccessResponse' + '400': + $ref: 'common.yaml#/components/responses/400BadRequest' + '401': + $ref: 'common.yaml#/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' + /api/v2/compute-pools/{name}:resume: + post: + summary: Resume a compute pool + tags: + - compute-pool + description: Resume a compute pool, if suspended. This is a no-op if it is already running. + operationId: resumeComputePool + parameters: + - $ref: 'common.yaml#/components/parameters/name' + responses: + '200': + $ref: 'common.yaml#/components/responses/200SuccessResponse' + '400': + $ref: 'common.yaml#/components/responses/400BadRequest' + '401': + $ref: 'common.yaml#/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' + /api/v2/compute-pools/{name}:suspend: + post: + summary: Perform an action on a compute pool + tags: + - compute-pool + description: Suspend a compute pool. + operationId: suspendComputePool + parameters: + - $ref: 'common.yaml#/components/parameters/name' + responses: + '200': + $ref: 'common.yaml#/components/responses/200SuccessResponse' + '400': + $ref: 'common.yaml#/components/responses/400BadRequest' + '401': + $ref: 'common.yaml#/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' + /api/v2/compute-pools/{name}:stopallservices: + post: + summary: Stops all services on the compute pool. + tags: + - compute-pool + description: Stop all services in the compute pool. + operationId: stopAllServicesInComputePool + parameters: + - $ref: 'common.yaml#/components/parameters/name' + responses: + '200': + $ref: 'common.yaml#/components/responses/200SuccessResponse' + '400': + $ref: 'common.yaml#/components/responses/400BadRequest' + '401': + $ref: 'common.yaml#/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: + ComputePool: + type: object + properties: + name: + $ref: './common.yaml#/components/schemas/Identifier' + warehouse: + $ref: './common.yaml#/components/schemas/Identifier' + min_nodes: + type: integer + max_nodes: + type: integer + instance_family: + type: string + auto_resume: + type: boolean + comment: + type: string + state: + type: string + readOnly: true + enum: [UNKNOWN, STARTING, IDLE, ACTIVE, STOPPING, SUSPENDED, RESIZING] + num_services: + type: integer + readOnly: true + auto_suspend_secs: + type: integer + format: int64 + active_nodes: + type: integer + readOnly: true + idle_nodes: + type: integer + readOnly: true + created_on: + type: string + format: date-time + readOnly: true + resumed_on: + type: string + format: date-time + readOnly: true + updated_on: + type: string + format: date-time + readOnly: true + owner: + type: string + readOnly: true + example: + name: compute_pool_name + warehouse: test_wh + min_nodes: 4 + max_nodes: 5 + instance_family: compute_pool_family + auto_resume: false + comment: test_comment + state: STARTING + num_services: 1 + auto_suspend_secs: 10 + active_nodes: 2 + idle_nodes: 2 + created_on: "YYYY-MM-DDTHH:MI:SS.FF6" + updated_on: "YYYY-MM-DDTHH:MI:SS.FF6" + resumed_on: "YYYY-MM-DDTHH:MI:SS.FF6" + owner: POOL_ADMIN + required: + - name + - instance_family + - min_nodes + - max_nodes +tags: + - name: compute-pool diff --git a/specification/private-preview/2023-11-13-private-preview/image-repositories.yaml b/specification/private-preview/2023-11-13-private-preview/image-repositories.yaml new file mode 100644 index 0000000..67a7689 --- /dev/null +++ b/specification/private-preview/2023-11-13-private-preview/image-repositories.yaml @@ -0,0 +1,195 @@ +openapi: 3.0.0 +servers: + - description: Snowflake Image Repositories API + url: https://org-account.snowflakecomputing.com +info: + version: 0.0.1 + title: Snowflake Image Repositories API + description: >- + The Snowflake Image Repositories API is a REST API that you can use to access, update, and perform certain actions on Image Repository resources 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: List image repositories + tags: + - image-repository + description: Lists the image repositories under the 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 + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ImageRepository' + '400': + $ref: 'common.yaml#/components/responses/400BadRequest' + '401': + $ref: 'common.yaml#/components/responses/401Unauthorized' + '403': + $ref: 'common.yaml#/components/responses/403Forbidden' + '404': + $ref: 'common.yaml#/components/responses/404NotFound' + '405': + $ref: 'common.yaml#/components/responses/405MethodNotAllowed' + '409': + $ref: 'common.yaml#/components/responses/409Conflict' + '500': + $ref: 'common.yaml#/components/responses/500InternalServerError' + '503': + $ref: 'common.yaml#/components/responses/503ServiceUnavailable' + '504': + $ref: 'common.yaml#/components/responses/504GatewayTimeout' + post: + summary: Create an image repository + tags: + - image-repository + description: Create an image repository, with standard create modifiers + as query parameters. 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' + '400': + $ref: 'common.yaml#/components/responses/400BadRequest' + '401': + $ref: 'common.yaml#/components/responses/401Unauthorized' + '403': + $ref: 'common.yaml#/components/responses/403Forbidden' + '404': + $ref: 'common.yaml#/components/responses/404NotFound' + '405': + $ref: 'common.yaml#/components/responses/405MethodNotAllowed' + '409': + $ref: 'common.yaml#/components/responses/409Conflict' + '500': + $ref: 'common.yaml#/components/responses/500InternalServerError' + '503': + $ref: 'common.yaml#/components/responses/503ServiceUnavailable' + '504': + $ref: 'common.yaml#/components/responses/504GatewayTimeout' + /api/v2/databases/{database}/schemas/{schema}/image-repositories/{name}: + get: + summary: Fetch an image repository. + tags: + - image-repository + description: Fetch an image repository using the SHOW command output. + 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 + content: + application/json: + schema: + $ref: '#/components/schemas/ImageRepository' + '400': + $ref: 'common.yaml#/components/responses/400BadRequest' + '401': + $ref: 'common.yaml#/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 an image repository + tags: + - image-repository + description: Delete an image repository 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: deleteImageRepository + responses: + '200': + $ref: 'common.yaml#/components/responses/200SuccessResponse' + '400': + $ref: 'common.yaml#/components/responses/400BadRequest' + '401': + $ref: 'common.yaml#/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: + ImageRepository: + type: object + 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 + format: date-time + readOnly: true + repository_url: + type: string + readOnly: true + owner: + type: string + readOnly: true + owner_role_type: + type: string + readOnly: true + example: + name: image_repository_name + database_name: test_db + schema_name: test_schema + created_on: "YYYY-MM-DDTHH:MI:SS.FF6" + repository_url: https://www.snowflake.com + owner: IMAGE_ADMIN + owner_role_type: ADMIN + required: + - name +tags: + - name: image-repository diff --git a/specification/private-preview/2023-11-13-private-preview/sessions.yaml b/specification/private-preview/2023-11-13-private-preview/sessions.yaml new file mode 100644 index 0000000..e53e790 --- /dev/null +++ b/specification/private-preview/2023-11-13-private-preview/sessions.yaml @@ -0,0 +1,175 @@ +openapi: 3.0.0 +servers: + - url: https://org-account.snowflakecomputing.com + description: Snowflake Sessions API +info: + title: Snowflake Sessions API + version: 0.0.1 + description: >- + The Snowflake Sessions API is a REST API that you can use to manage Snowflake sessions and session tokens. + contact: + name: Snowflake, Inc. + url: https://www.snowflake.com + email: support@snowflake.com +security: + - NONE: [] + - bearerAuth: [] +paths: + /api/v2/sessions: + post: + summary: Create a session + tags: + - session + description: Create a session, with keys pairs or Oath authentication methods. + operationId: createSession + security: + - bearerAuth: [] + parameters: + - $ref: 'common.yaml#/components/parameters/content-type' + - $ref: 'common.yaml#/components/parameters/accept' + - $ref: 'common.yaml#/components/parameters/x-snowflake-authorization-token-type' + requestBody: + required: false + content: + application/json: + schema: + $ref: '#/components/schemas/CreateSessionRequest' + responses: + '200': + description: successful + content: + application/json: + schema: + $ref: '#/components/schemas/CreateSessionResponse' + '400': + $ref: 'common.yaml#/components/responses/400BadRequest' + '401': + $ref: 'common.yaml#/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/sessions/{sessionId}: + delete: + summary: Close a session + tags: + - session + description: Close the current session + operationId: deleteSession + parameters: + - $ref: 'common.yaml#/components/parameters/sessionId' + - $ref: 'common.yaml#/components/parameters/content-type' + responses: + '200': + $ref: 'common.yaml#/components/responses/200SuccessResponse' + '400': + $ref: 'common.yaml#/components/responses/400BadRequest' + '401': + $ref: 'common.yaml#/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/sessions/{sessionId}:refresh-token: + post: + summary: Request new session tokens + tags: + - session + description: Request new session tokens by providing the master token. + operationId: requestSessionToken + parameters: + - $ref: 'common.yaml#/components/parameters/sessionId' + - $ref: 'common.yaml#/components/parameters/content-type' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TokenRequest' + responses: + '200': + description: successful + content: + application/json: + schema: + $ref: '#/components/schemas/CreateSessionResponse' + '400': + $ref: 'common.yaml#/components/responses/400BadRequest' + '401': + $ref: 'common.yaml#/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' + +components: + securitySchemes: + bearerAuth: + $ref: 'common.yaml#/components/securitySchemes/keyPair' + schemas: + CreateSessionResponse: + type: object + properties: + token: + type: string + readOnly: true + validityInSeconds: + type: integer + readOnly: true + masterToken: + type: string + readOnly: true + masterValidityInSeconds: + type: integer + readOnly: true + sessionId: + type: integer + readOnly: true + CreateSessionRequest: + type: object + properties: + roleName: + type: string + TokenRequest: + type: object + properties: + sessionToken: + type: string + +tags: + - name: session diff --git a/specification/private-preview/2023-11-13-private-preview/tasks.yaml b/specification/private-preview/2023-11-13-private-preview/tasks.yaml new file mode 100644 index 0000000..dc55006 --- /dev/null +++ b/specification/private-preview/2023-11-13-private-preview/tasks.yaml @@ -0,0 +1,641 @@ +openapi: 3.0.0 +servers: + - description: Snowflake Tasks API + url: https://org-account.snowflakecomputing.com +info: + version: 0.0.1 + title: Snowflake Tasks API + description: >- + The Snowflake Tasks 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' + responses: + '200': + description: successful + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Task' + '400': + $ref: 'common.yaml#/components/responses/400BadRequest' + '401': + $ref: 'common.yaml#/components/responses/401Unauthorized' + '403': + $ref: 'common.yaml#/components/responses/403Forbidden' + '404': + $ref: 'common.yaml#/components/responses/404NotFound' + '405': + $ref: 'common.yaml#/components/responses/405MethodNotAllowed' + '409': + $ref: 'common.yaml#/components/responses/409Conflict' + '429': + $ref: 'common.yaml#/components/responses/429LimitExceeded' + '500': + $ref: 'common.yaml#/components/responses/500InternalServerError' + '503': + $ref: 'common.yaml#/components/responses/503ServiceUnavailable' + '504': + $ref: 'common.yaml#/components/responses/504GatewayTimeout' + post: + + summary: Create a task + tags: + - task + description: Create a task, with standard create modifiers + as query parameters. See the Task component definition + for what is required to be provided in the request body. + operationId: createTask + parameters: + - $ref: 'common.yaml#/components/parameters/database' + - $ref: 'common.yaml#/components/parameters/schema' + - $ref: 'common.yaml#/components/parameters/createMode' + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Task' + responses: + '200': + $ref: 'common.yaml#/components/responses/200SuccessResponse' + '400': + $ref: 'common.yaml#/components/responses/400BadRequest' + '401': + $ref: 'common.yaml#/components/responses/401Unauthorized' + '403': + $ref: 'common.yaml#/components/responses/403Forbidden' + '404': + $ref: 'common.yaml#/components/responses/404NotFound' + '405': + $ref: 'common.yaml#/components/responses/405MethodNotAllowed' + '409': + $ref: 'common.yaml#/components/responses/409Conflict' + '429': + $ref: 'common.yaml#/components/responses/429LimitExceeded' + '500': + $ref: 'common.yaml#/components/responses/500InternalServerError' + '503': + $ref: 'common.yaml#/components/responses/503ServiceUnavailable' + '504': + $ref: 'common.yaml#/components/responses/504GatewayTimeout' + /api/v2/databases/{database}/schemas/{schema}/tasks/{name}: + get: + summary: Fetch a task + tags: + - task + description: Fetch a task using the describe command output. + operationId: fetchTask + parameters: + - $ref: 'common.yaml#/components/parameters/database' + - $ref: 'common.yaml#/components/parameters/schema' + - $ref: 'common.yaml#/components/parameters/name' + responses: + '200': + description: successful + content: + application/json: + schema: + $ref: '#/components/schemas/Task' + '400': + $ref: 'common.yaml#/components/responses/400BadRequest' + '401': + $ref: 'common.yaml#/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' + '400': + $ref: 'common.yaml#/components/responses/400BadRequest' + '401': + $ref: 'common.yaml#/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' + '400': + $ref: 'common.yaml#/components/responses/400BadRequest' + '401': + $ref: 'common.yaml#/components/responses/401Unauthorized' + '403': + $ref: 'common.yaml#/components/responses/403Forbidden' + '404': + $ref: 'common.yaml#/components/responses/404NotFound' + '405': + $ref: 'common.yaml#/components/responses/405MethodNotAllowed' + '429': + $ref: 'common.yaml#/components/responses/429LimitExceeded' + '500': + $ref: 'common.yaml#/components/responses/500InternalServerError' + '503': + $ref: 'common.yaml#/components/responses/503ServiceUnavailable' + '504': + $ref: 'common.yaml#/components/responses/504GatewayTimeout' + /api/v2/databases/{database}/schemas/{schema}/tasks/{name}:execute: + post: + summary: Execute a task object. + tags: + - task + description: Execute a task -- this is equivalent to EXECUTE IMMEDIATE. + operationId: executeTask + parameters: + - $ref: 'common.yaml#/components/parameters/database' + - $ref: 'common.yaml#/components/parameters/schema' + - $ref: 'common.yaml#/components/parameters/name' + - name: retryLast + in: query + description: Retry the last failed run of the DAG. + schema: + type: boolean + default: false + responses: + '200': + $ref: 'common.yaml#/components/responses/200SuccessResponse' + '400': + $ref: 'common.yaml#/components/responses/400BadRequest' + '401': + $ref: 'common.yaml#/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' + '400': + $ref: 'common.yaml#/components/responses/400BadRequest' + '401': + $ref: 'common.yaml#/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' + '400': + $ref: 'common.yaml#/components/responses/400BadRequest' + '401': + $ref: 'common.yaml#/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' + responses: + '200': + description: successful + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Task' + '400': + $ref: 'common.yaml#/components/responses/400BadRequest' + '401': + $ref: 'common.yaml#/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 + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TaskRun' + '400': + $ref: 'common.yaml#/components/responses/400BadRequest' + '401': + $ref: 'common.yaml#/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 + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/TaskRun' + '400': + $ref: 'common.yaml#/components/responses/400BadRequest' + '401': + $ref: 'common.yaml#/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 + properties: + root_task_name: + type: string + readOnly: true + database_name: + type: string + readOnly: true + schema_name: + type: string + readOnly: true + state: + type: string + enum: [SCHEDULED, EXECUTING, SUCCEEDED, FAILED, CANCELLED] + readOnly: true + first_error_task_name: + type: string + readOnly: true + first_error_code: + type: integer + readOnly: true + first_error_message: + type: string + readOnly: true + scheduled_time: + type: string + format: date-time + readOnly: true + query_start_time: + type: string + format: date-time + readOnly: true + next_scheduled_time: + type: string + format: date-time + readOnly: true + completed_time: + type: string + format: date-time + readOnly: true + root_task_id: + type: string + readOnly: true + graph_version: + type: integer + readOnly: true + run_id: + type: integer + 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: "YYYY-MM-DDTHH24:MI:SS.FF6" + query_start_time: "YYYY-MM-DDTHH24:MI:SS.FF6" + next_scheduled_time: "YYYY-MM-DDTHH24:MI:SS.FF6" + completed_time: "YYYY-MM-DDTHH24:MI:SS.FF6" + 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 + properties: + name: + $ref: './common.yaml#/components/schemas/Identifier' + warehouse: + $ref: './common.yaml#/components/schemas/Identifier' + schedule: + oneOf: + - $ref: '#/components/schemas/MinutesSchedule' + - $ref: '#/components/schemas/CronSchedule' + discriminator: + propertyName: schedule_type + mapping: + CRON_TYPE: '#/components/schemas/CronSchedule' + MINUTES_TYPE: '#/components/schemas/MinutesSchedule' + comment: + type: string + config: + type: object + additionalProperties: true + description: Task Config + definition: + type: string + predecessors: + type: array + items: + type: string + user_task_managed_initial_warehouse_size: + type: string + user_task_timeout_ms: + type: integer + suspend_task_after_num_failures: + type: integer + condition: + type: string + allow_overlapping_execution: + type: boolean + error_integration: + type: string + created_on: + type: string + format: date-time + readOnly: true + id: + type: string + readOnly: true + owner: + type: string + readOnly: true + owner_role_type: + type: string + readOnly: true + state: + type: string + readOnly: true + enum: [started, suspended] + last_committed_on: + type: string + readOnly: true + format: date-time + last_suspended_on: + type: string + readOnly: true + format: date-time + database_name: + type: string + readOnly: true + schema_name: + type: string + readOnly: true + example: + name: task_name + 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: "YYYY-MM-DDTHH:MI:SS.FF6" + id: task_id + owner: TASK_ADMIN + owner_role_type: ADMIN + state: started + last_committed_on: "YYYY-MM-DDTHH:MI:SS.FF6" + last_suspended_on: "YYYY-MM-DDTHH:MI:SS.FF6" + database_name: TESTDB + schema_name: TESTSCHEMA + required: + - name + - definition + CronSchedule: + type: object + properties: + cron_expr: + type: string + timezone: + type: string + example: + cron_expr: "* * * * ? *" + timezone: america/los_angeles + required: + - cron_expr + - timezone + MinutesSchedule: + type: object + properties: + minutes: + type: integer + example: + minutes: 10 + required: + - minutes +externalDocs: + description: Streams and Tasks Reference + url: https://docs.snowflake.com/en/sql-reference/commands-stream +tags: + - name: task