Sign in

00c653316d35

latestOpenAPI 3.0.32026-08-13154321638.4 KB
Harbors

Create Harbor

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.

post/api/harbors

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/harbors/revenue_operations",
      "name": "Revenue Operations",
      "organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d"
    }
  }
}