---
title: "Register bucket - guide"
method: GET
path: "/v2/storage/branch/{branchId}/buckets/register-guide"
tags: ["Buckets"]
---

# Register bucket - guide

`GET /v2/storage/branch/{branchId}/buckets/register-guide`

## Request

- Base URL: `https://connection.keboola.com`
- URL: `https://connection.keboola.com/v2/storage/branch/{branchId}/buckets/register-guide`
- Auth: one of:
  - API key in header `X-StorageApi-Token`
  - API key in header `X-KBC-ManageApiToken`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/keboola/apis/keboola-storage-api/docs/v2/storage/branch/:branchId/buckets/register-guide/get.ts> (a function with typed inputs; its response is checked against the schema)

**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.

## Path parameters

- `branchId` string, required

## Query parameters

- `path[]` string[], required: Path to the schema. Snowflake: `["database-name", "schema-name"]`; BigQuery: `["dataset-name"]`.
- `backend` 'snowflake' | 'bigquery', nullable: Bucket backend type; the default value is determined by the project settings.
- `isSnowflakeSharedDatabase` boolean, nullable: Render the guide for a Snowflake shared database.

## Response `200`

Markdown guide for registering the bucket.

- BucketRegisterGuideResponse
  - `markdown` string, required: Registration guide in Markdown format.

## Other responses

- `400`: Invalid request, the project lacks the `input-mapping-read-only-storage` or `external-buckets` feature (`manage.project.missingFeatureFlag`), or the backend is not supported or not assigned to the project (`storage.backendNotAllowed`).
- `403`: The token cannot manage buckets.
- `501`: The endpoint is available in the default branch only.

---

[API](https://skmtc.dev/keboola/apis/keboola-storage-api.md) - [All operations](https://skmtc.dev/keboola/apis/keboola-storage-api/llms.txt) - [OpenAPI document](https://skmtc.dev/keboola/apis/keboola-storage-api/revisions/34b5ceac0317?raw)