Create Harbor

Beta

POST

https://app.polytomic.com/api/harbors

POST

/api/harbors

curl -X POST https://app.polytomic.com/api/harbors \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "backing_mode": "managed",
  "name": "Revenue Operations"
}'

{
  "data": {
    "api_key": {
      "created_at": "2024-01-15T09:30:00Z",
      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "mode": "profile",
      "value": "string"
    },
    "harbor": {
      "backing_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "backing_mode": "managed",
      "created_at": "2024-01-15T09:30:00Z",
      "description": "string",
      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "mcp_server_url": "https://mcp.polytomic.com/mcp/harbor/revenue_operations",
      "name": "Revenue Operations",
      "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "status": "provisioning",
      "updated_at": "2024-01-15T09:30:00Z"
    }
  }
}

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.

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

AuthorizationBasic

Basic organization-scoped API key

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

dataobjectOptional

Errors

403

Forbidden Error

409

Conflict Error

422

Unprocessable Entity Error

500

Internal Server Error

Authentication

Headers

Request

Response

Errors