{ "info": { "_postman_id": "b879ccbc-0694-41be-9112-162a8325d6f6", "name": "Snowflake Stage API", "description": "The Snowflake Stage API is a REST API that you can use to access, update, and perform certain actions on stage resources in a Snowflake database.\n\nContact Support:\n Name: Snowflake, Inc.\n Email: support@snowflake.com", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "53314882", "_collection_link": "https://go.postman.co/collection/53314882-b879ccbc-0694-41be-9112-162a8325d6f6?source=collection_link" }, "item": [ { "name": "api", "item": [ { "name": "v2", "item": [ { "name": "databases", "item": [ { "name": "{database}", "item": [ { "name": "schemas", "item": [ { "name": "{schema}", "item": [ { "name": "stages", "item": [ { "name": "{name}", "item": [ { "name": "files", "item": [ { "name": "{filePath}:presigned-url", "item": [ { "name": "Generate a presigned url and optionally encryption materials.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"expiration_time\": 1997\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files/{{filePath}}:presigned-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name", "files", "{{filePath}}:presigned-url" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] }, "description": "Generate a presigned url and optionally encryption materials for uploading and downloading files." }, "response": [ { "name": "successful", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"expiration_time\": 1997\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files/{{filePath}}:presigned-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name", "files", "{{filePath}}:presigned-url" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"presigned_url\": \"string\"\n}" }, { "name": "Successfully accepted the request, but it is not completed yet.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"expiration_time\": 1997\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files/{{filePath}}:presigned-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name", "files", "{{filePath}}:presigned-url" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Location", "value": "string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"code\": \"392604\",\n \"message\": \"Request execution in progress. Use the provided location header or result handler ID to perform query monitoring and management.\"\n}" }, { "name": "Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct request payload. The response body may include the error code and message indicating the actual cause. The application must reconstruct the r", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"expiration_time\": 1997\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files/{{filePath}}:presigned-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name", "files", "{{filePath}}:presigned-url" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response body may include the error code and message indicating the actual cause, e.g., expired, invalid token. The application must obtain a", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"expiration_time\": 1997\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files/{{filePath}}:presigned-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name", "files", "{{filePath}}:presigned-url" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"expiration_time\": 1997\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files/{{filePath}}:presigned-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name", "files", "{{filePath}}:presigned-url" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"expiration_time\": 1997\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files/{{filePath}}:presigned-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name", "files", "{{filePath}}:presigned-url" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Method Not Allowed. The request method doesn't match the supported API. This happens, for example, if the application calls the API with GET method but the endpoint accepts only POST.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"expiration_time\": 1997\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files/{{filePath}}:presigned-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name", "files", "{{filePath}}:presigned-url" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"expiration_time\": 1997\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files/{{filePath}}:presigned-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name", "files", "{{filePath}}:presigned-url" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Internal Server Error. The server hit an unrecoverable system error. The response body may include the error code and message for further guidance. The application owner may need to reach out the customer support.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"expiration_time\": 1997\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files/{{filePath}}:presigned-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name", "files", "{{filePath}}:presigned-url" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"expiration_time\": 1997\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files/{{filePath}}:presigned-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name", "files", "{{filePath}}:presigned-url" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"expiration_time\": 1997\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files/{{filePath}}:presigned-url", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name", "files", "{{filePath}}:presigned-url" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Gateway Timeout", "code": 504, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" } ] } ] }, { "name": "List files in the stage.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files?pattern=.*data_0.*", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name", "files" ], "query": [ { "description": "Parameter that filters the command output by a regular expression pattern.", "key": "pattern", "value": ".*data_0.*" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] }, "description": "List files in the stage -- this is equivalent to LIST @stage." }, "response": [ { "name": "successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files?pattern=.*data_0.*", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name", "files" ], "query": [ { "description": "Parameter that filters the command output by a regular expression pattern.", "key": "pattern", "value": ".*data_0.*" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Link", "value": "" } ], "cookie": [], "body": "[\n {\n \"name\": \"string\",\n \"size\": \"string\",\n \"md5\": \"string\",\n \"last_modified\": \"string\"\n },\n {\n \"name\": \"string\",\n \"size\": \"string\",\n \"md5\": \"string\",\n \"last_modified\": \"string\"\n }\n]" }, { "name": "Successfully accepted the request, but it is not completed yet.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files?pattern=.*data_0.*", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name", "files" ], "query": [ { "description": "Parameter that filters the command output by a regular expression pattern.", "key": "pattern", "value": ".*data_0.*" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Location", "value": "string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"code\": \"392604\",\n \"message\": \"Request execution in progress. Use the provided location header or result handler ID to perform query monitoring and management.\"\n}" }, { "name": "Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct request payload. The response body may include the error code and message indicating the actual cause. The application must reconstruct the r", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files?pattern=.*data_0.*", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name", "files" ], "query": [ { "description": "Parameter that filters the command output by a regular expression pattern.", "key": "pattern", "value": ".*data_0.*" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response body may include the error code and message indicating the actual cause, e.g., expired, invalid token. The application must obtain a", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files?pattern=.*data_0.*", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name", "files" ], "query": [ { "description": "Parameter that filters the command output by a regular expression pattern.", "key": "pattern", "value": ".*data_0.*" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files?pattern=.*data_0.*", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name", "files" ], "query": [ { "description": "Parameter that filters the command output by a regular expression pattern.", "key": "pattern", "value": ".*data_0.*" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files?pattern=.*data_0.*", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name", "files" ], "query": [ { "description": "Parameter that filters the command output by a regular expression pattern.", "key": "pattern", "value": ".*data_0.*" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Method Not Allowed. The request method doesn't match the supported API. This happens, for example, if the application calls the API with GET method but the endpoint accepts only POST.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files?pattern=.*data_0.*", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name", "files" ], "query": [ { "description": "Parameter that filters the command output by a regular expression pattern.", "key": "pattern", "value": ".*data_0.*" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files?pattern=.*data_0.*", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name", "files" ], "query": [ { "description": "Parameter that filters the command output by a regular expression pattern.", "key": "pattern", "value": ".*data_0.*" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Internal Server Error. The server hit an unrecoverable system error. The response body may include the error code and message for further guidance. The application owner may need to reach out the customer support.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files?pattern=.*data_0.*", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name", "files" ], "query": [ { "description": "Parameter that filters the command output by a regular expression pattern.", "key": "pattern", "value": ".*data_0.*" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files?pattern=.*data_0.*", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name", "files" ], "query": [ { "description": "Parameter that filters the command output by a regular expression pattern.", "key": "pattern", "value": ".*data_0.*" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name/files?pattern=.*data_0.*", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name", "files" ], "query": [ { "description": "Parameter that filters the command output by a regular expression pattern.", "key": "pattern", "value": ".*data_0.*" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Gateway Timeout", "code": 504, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" } ] } ] }, { "name": "Fetch a stage", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] }, "description": "Fetch a stage using the describe command output." }, "response": [ { "name": "successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Link", "value": "" } ], "cookie": [], "body": "{\n \"name\": \"stage_name\"\n}" }, { "name": "Successfully accepted the request, but it is not completed yet.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Location", "value": "string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"code\": \"392604\",\n \"message\": \"Request execution in progress. Use the provided location header or result handler ID to perform query monitoring and management.\"\n}" }, { "name": "Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct request payload. The response body may include the error code and message indicating the actual cause. The application must reconstruct the r", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response body may include the error code and message indicating the actual cause, e.g., expired, invalid token. The application must obtain a", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Method Not Allowed. The request method doesn't match the supported API. This happens, for example, if the application calls the API with GET method but the endpoint accepts only POST.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Internal Server Error. The server hit an unrecoverable system error. The response body may include the error code and message for further guidance. The application owner may need to reach out the customer support.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name" ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Gateway Timeout", "code": 504, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" } ] }, { "name": "Delete a stage", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `true`: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] }, "description": "Delete a stage with the stage name. If ifExists is used, the operation will succeed even if the object does not exist. Otherwise, there will be a failure if the drop is unsuccessful." }, "response": [ { "name": "Successful request.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `true`: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"status\": \"Request successfully completed\"\n}" }, { "name": "Successfully accepted the request, but it is not completed yet.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `true`: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Location", "value": "string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"code\": \"392604\",\n \"message\": \"Request execution in progress. Use the provided location header or result handler ID to perform query monitoring and management.\"\n}" }, { "name": "Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct request payload. The response body may include the error code and message indicating the actual cause. The application must reconstruct the r", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `true`: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response body may include the error code and message indicating the actual cause, e.g., expired, invalid token. The application must obtain a", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `true`: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `true`: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `true`: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Method Not Allowed. The request method doesn't match the supported API. This happens, for example, if the application calls the API with GET method but the endpoint accepts only POST.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `true`: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `true`: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Internal Server Error. The server hit an unrecoverable system error. The response body may include the error code and message for further guidance. The application owner may need to reach out the customer support.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `true`: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `true`: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages/:name?ifExists=true", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages", ":name" ], "query": [ { "description": "Parameter that specifies how to handle the request for a resource that does not exist:\n- `true`: The endpoint does not throw an error if the resource does not exist. It returns a 200 success response, but does not take any action on the resource.\n- `false`: The endpoint throws an error if the resource doesn't exist.", "key": "ifExists", "value": "true" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." }, { "key": "name", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the resource." } ] } }, "status": "Gateway Timeout", "code": 504, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" } ] } ] }, { "name": "List stages", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?like=test_%", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages" ], "query": [ { "description": "Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.", "key": "like", "value": "test_%" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] }, "description": "Lists stages under the database and schema, with show options as query parameters." }, "response": [ { "name": "successful", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?like=test_%", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages" ], "query": [ { "description": "Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.", "key": "like", "value": "test_%" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Link", "value": "" } ], "cookie": [], "body": "[\n {\n \"name\": \"stage_name\"\n },\n {\n \"name\": \"stage_name\"\n }\n]" }, { "name": "Successfully accepted the request, but it is not completed yet.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?like=test_%", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages" ], "query": [ { "description": "Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.", "key": "like", "value": "test_%" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Location", "value": "string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"code\": \"392604\",\n \"message\": \"Request execution in progress. Use the provided location header or result handler ID to perform query monitoring and management.\"\n}" }, { "name": "Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct request payload. The response body may include the error code and message indicating the actual cause. The application must reconstruct the r", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?like=test_%", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages" ], "query": [ { "description": "Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.", "key": "like", "value": "test_%" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response body may include the error code and message indicating the actual cause, e.g., expired, invalid token. The application must obtain a", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?like=test_%", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages" ], "query": [ { "description": "Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.", "key": "like", "value": "test_%" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?like=test_%", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages" ], "query": [ { "description": "Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.", "key": "like", "value": "test_%" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?like=test_%", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages" ], "query": [ { "description": "Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.", "key": "like", "value": "test_%" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Method Not Allowed. The request method doesn't match the supported API. This happens, for example, if the application calls the API with GET method but the endpoint accepts only POST.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?like=test_%", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages" ], "query": [ { "description": "Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.", "key": "like", "value": "test_%" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?like=test_%", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages" ], "query": [ { "description": "Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.", "key": "like", "value": "test_%" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Request Timeout", "code": 408, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Conflict. The requested operation could not be performed due to a conflicting state that could not be resolved. This usually happens when a CREATE request was performed when there is a pre-existing resource with the same name, and also without one of the ", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?like=test_%", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages" ], "query": [ { "description": "Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.", "key": "like", "value": "test_%" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?like=test_%", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages" ], "query": [ { "description": "Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.", "key": "like", "value": "test_%" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Internal Server Error. The server hit an unrecoverable system error. The response body may include the error code and message for further guidance. The application owner may need to reach out the customer support.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?like=test_%", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages" ], "query": [ { "description": "Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.", "key": "like", "value": "test_%" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?like=test_%", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages" ], "query": [ { "description": "Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.", "key": "like", "value": "test_%" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?like=test_%", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages" ], "query": [ { "description": "Parameter to filter the command output by resource name. Uses case-insensitive pattern matching, with support for SQL wildcard characters.", "key": "like", "value": "test_%" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Gateway Timeout", "code": 504, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" } ] }, { "name": "Create a stage", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"stage_name\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?createMode=ifNotExists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages" ], "query": [ { "description": "Parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.", "key": "createMode", "value": "ifNotExists" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] }, "description": "Create a stage, with standard create modifiers as query parameters. See the Stage component definition for what is required to be provided in the request body." }, "response": [ { "name": "Successful request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"stage_name\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?createMode=ifNotExists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages" ], "query": [ { "description": "Parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.", "key": "createMode", "value": "ifNotExists" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"status\": \"Request successfully completed\"\n}" }, { "name": "Successfully accepted the request, but it is not completed yet.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"stage_name\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?createMode=ifNotExists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages" ], "query": [ { "description": "Parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.", "key": "createMode", "value": "ifNotExists" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Location", "value": "string" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"code\": \"392604\",\n \"message\": \"Request execution in progress. Use the provided location header or result handler ID to perform query monitoring and management.\"\n}" }, { "name": "Bad Request. The request payload is invalid or malformed. This happens if the application didn't send the correct request payload. The response body may include the error code and message indicating the actual cause. The application must reconstruct the r", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"stage_name\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?createMode=ifNotExists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages" ], "query": [ { "description": "Parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.", "key": "createMode", "value": "ifNotExists" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Unauthorized. The request is not authorized. This happens if the attached access token is invalid or missing. The response body may include the error code and message indicating the actual cause, e.g., expired, invalid token. The application must obtain a", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"stage_name\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?createMode=ifNotExists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages" ], "query": [ { "description": "Parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.", "key": "createMode", "value": "ifNotExists" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Forbidden. The request is forbidden. This can also happen if the request is made even if the API is not enabled.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"stage_name\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?createMode=ifNotExists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages" ], "query": [ { "description": "Parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.", "key": "createMode", "value": "ifNotExists" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Not Found. The request endpoint is not valid. This happens if the API endpoint does not exist, or if the API is not enabled.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"stage_name\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?createMode=ifNotExists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages" ], "query": [ { "description": "Parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.", "key": "createMode", "value": "ifNotExists" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Method Not Allowed. The request method doesn't match the supported API. This happens, for example, if the application calls the API with GET method but the endpoint accepts only POST.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"stage_name\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?createMode=ifNotExists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages" ], "query": [ { "description": "Parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.", "key": "createMode", "value": "ifNotExists" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Request Timeout. This indicates that the request from the client timed out and was not completed by the server.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"stage_name\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?createMode=ifNotExists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages" ], "query": [ { "description": "Parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.", "key": "createMode", "value": "ifNotExists" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Request Timeout", "code": 408, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Conflict. The requested operation could not be performed due to a conflicting state that could not be resolved. This usually happens when a CREATE request was performed when there is a pre-existing resource with the same name, and also without one of the ", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"stage_name\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?createMode=ifNotExists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages" ], "query": [ { "description": "Parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.", "key": "createMode", "value": "ifNotExists" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Limit Exceeded. The number of requests hit the rate limit. The application must slow down the frequency of hitting the API endpoints.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"stage_name\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?createMode=ifNotExists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages" ], "query": [ { "description": "Parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.", "key": "createMode", "value": "ifNotExists" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Internal Server Error. The server hit an unrecoverable system error. The response body may include the error code and message for further guidance. The application owner may need to reach out the customer support.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"stage_name\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?createMode=ifNotExists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages" ], "query": [ { "description": "Parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.", "key": "createMode", "value": "ifNotExists" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Service Unavailable. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"stage_name\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?createMode=ifNotExists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages" ], "query": [ { "description": "Parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.", "key": "createMode", "value": "ifNotExists" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" }, { "name": "Gateway Timeout. The request was not processed due to server side timeouts. The application may retry with backoff. The jittered backoff is recommended.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"stage_name\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/api/v2/databases/:database/schemas/:schema/stages?createMode=ifNotExists", "host": [ "{{baseUrl}}" ], "path": [ "api", "v2", "databases", ":database", "schemas", ":schema", "stages" ], "query": [ { "description": "Parameter allowing support for different modes of resource creation. Possible values include:\n- `errorIfExists`: Throws an error if you try to create a resource that already exists.\n- `orReplace`: Automatically replaces the existing resource with the current one.\n- `ifNotExists`: Creates a new resource when an alter is requested for a non-existent resource.", "key": "createMode", "value": "ifNotExists" } ], "variable": [ { "key": "database", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the database to which the resource belongs. You can use the `/api/v2/databases` GET request to get a list of available databases." }, { "key": "schema", "value": "TEST_NAME", "description": "Identifier (i.e. name) for the schema to which the resource belongs. You can use the `/api/v2/databases/{database}/schemas` GET request to get a list of available schemas for the specified database." } ] } }, "status": "Gateway Timeout", "code": 504, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "X-Snowflake-Request-ID", "value": "" } ], "cookie": [], "body": "{\n \"message\": \"Compilation error!\",\n \"error_code\": \"390189\",\n \"request_id\": \"01afef9d-0607-0550-0001-dd270c3902d7\"\n}" } ] } ] } ] } ] } ] } ] } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://org-account.snowflakecomputing.com" }, { "key": "filePath", "value": "string" } ] }