Buckets
Register bucket - guide
EXPERIMENTAL
Returns a guide on how exactly you should register the external bucket. The text is Markdown formatted. Available for Snowflake and BigQuery backend only. Requires the external-buckets and input-mapping-read-only-storage project features and is available in the default branch only.
get/v2/storage/branch/{branchId}/buckets/register-guide
Request
- Base URLhttps://connection.keboola.com
- Auth
- API key in header X-StorageApi-Token
- or API key in header X-KBC-ManageApiToken
- or HTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
branchIdstring required
Query parameters
path[]string[] required
Path to the schema. Snowflake: ["database-name", "schema-name"]; BigQuery: ["dataset-name"].
[ "my-database-name", "my-schema-name" ]
backend'snowflake' | 'bigquery' nullable
Bucket backend type; the default value is determined by the project settings.
Example:snowflake
isSnowflakeSharedDatabaseboolean nullable
Render the guide for a Snowflake shared database.
Response
Markdown guide for registering the bucket.
Changes
No recorded changes to this operation across all 1 revision of this API.