Skip to navigation
API ReferenceHarbors

Create Harbor

Beta

Creates a managed or customer-managed Harbor in the caller’s current organization.

generate_api_key defaults to true. Polytomic returns a new plaintext credential only in this response. Set it to false to create the Harbor without a credential.

For customer_managed, backing_connection_id must identify a queryable Connection that your credential can access.

Managed Harbors return with status: provisioning while Polytomic sets up their storage in the background. Poll GET /api/harbors/{harbor_id} until the status is ready before adding sources or querying data. If provisioning fails, the status is provisioning_failed and Polytomic retries automatically.

Authentication

AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic

Basic organization-scoped API key

Headers

X-Polytomic-VersionstringOptional

Request

This endpoint expects an object.
backing_modestringRequired

How the Harbor’s queryable data store is provided. Valid values are managed and customer_managed.

namestringRequired

Human-readable Harbor name.

backing_connection_idstringOptionalformat: "uuid"

Existing queryable Connection used by a customer-managed Harbor. Required only when backing_mode is customer_managed.

descriptionstringOptional
Short description of the Harbor. Maximum 1,000 characters.
generate_api_keyboolean or nullOptionalDefaults to true
Whether to generate a profile credential. Defaults to true.

Response

OK
dataobjectOptional

Errors

403
Forbidden Error
409
Conflict Error
422
Unprocessable Entity Error
500
Internal Server Error