POpolytomic
Harbors

Create Harbor

Changed on

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.

post/api/harbors

Request

  • Base URL
    https://app.polytomic.com
  • Auth
    • HTTP bearer
    • or HTTP basic

Headers

X-Polytomic-Versionstring

Request body

backing_connection_idstring uuid

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

backing_modestring required

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

descriptionstring

Short description of the Harbor. Maximum 1,000 characters.

generate_api_keyboolean nullable

Whether to generate a profile credential. Defaults to true.

namestring required

Human-readable Harbor name

Example request

{
  "backing_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
  "backing_mode": "managed",
  "description": "Revenue, pipeline, and renewal data",
  "generate_api_key": true,
  "name": "Revenue Operations"
}

Response

OK

Example response

{
  "data": {
    "api_key": {
      "id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "mode": "profile"
    },
    "harbor": {
      "backing_connection_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
      "backing_mode": "managed",
      "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"
    }
  }
}

Changes

  • d80b0fdea14eRevision changes
    • breaking

      the response's property type changed from object to no type for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      added to the response property allOf list for the response status

  • 61c2b96f65baRevision changes
    • breaking

      the / response's property type changed from object to no type for status

    • breaking

      the / response's property type changed from object to no type for status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added to the / response property allOf list for the response status

    • info

      added to the / response property allOf list for the response status