> This page is for version 2025-09-18 (default).
> For other versions, use one of these documentation indexes:
> - 2025-09-18 (default): https://apidocs.polytomic.com/2025-09-18/llms.txt
> - 2024-02-08: https://apidocs.polytomic.com/2024-02-08/llms.txt
> - 2023-04-25: https://apidocs.polytomic.com/2023-04-25/llms.txt
> - 2022-12-12: https://apidocs.polytomic.com/2022-12-12/llms.txt
> - 2021-05-23: https://apidocs.polytomic.com/2021-05-23/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://apidocs.polytomic.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://apidocs.polytomic.com/_mcp/server.

# Create Harbor

POST https://app.polytomic.com/api/harbors
Content-Type: application/json

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.

Reference: https://apidocs.polytomic.com/api-reference/harbors/create

## Authentication

- `Authorization` header (bearer token, required) — Bearer user API key
- `Authorization` header (basic auth, required) — Basic organization-scoped API key

## Request

### Body (application/json)

This endpoint expects a CreateHarborRequest.

- `backing_mode` (string, required) — How the Harbor's queryable data store is provided. Valid values are managed and customer_managed.
- `name` (string, required) — Human-readable Harbor name.
- `backing_connection_id` (string, optional) — Existing queryable Connection used by a customer-managed Harbor. Required only when backing_mode is customer_managed.
- `description` (string, optional) — Short description of the Harbor. Maximum 1,000 characters.
- `generate_api_key` (boolean, optional, nullable, default: true) — Whether to generate a profile credential. Defaults to true.

## Response

### 200

OK

- `data` (CreateHarborResponse, optional)

## Errors

### 403 Forbidden Error

Forbidden

- `key` (string, optional)
- `message` (string, optional)
- `metadata` (map from string to any, optional)
- `status` (integer, optional)

### 409 Conflict Error

Conflict

- `key` (string, optional)
- `message` (string, optional)
- `metadata` (map from string to any, optional)
- `status` (integer, optional)

### 422 Unprocessable Entity Error

Unprocessable Entity

- `key` (string, optional)
- `message` (string, optional)
- `metadata` (map from string to any, optional)
- `status` (integer, optional)

### 500 Internal Server Error

Internal Server Error

- `key` (string, optional)
- `message` (string, optional)
- `metadata` (map from string to any, optional)
- `status` (integer, optional)

## Types

### CreateHarborResponse

- `api_key` (HarborAPIKeyCreatedResponse, optional)
- `harbor` (HarborResponse, optional)

### HarborAPIKeyCreatedResponse

- `created_at` (datetime, optional) — When the credential was created.
- `id` (string, optional) — Unique identifier of the credential.
- `mode` (string, optional) — Credential authorization mode.
- `value` (string, optional) — Plaintext credential. This value is returned only once.

### HarborResponse

- `backing_connection_id` (string, optional) — Connection that provides the Harbor's queryable data store.
- `backing_mode` (string, optional) — How the Harbor's queryable data store is provided.
- `created_at` (datetime, optional) — When the Harbor was created.
- `description` (string, optional) — Short description of the Harbor.
- `id` (string, optional) — Unique identifier of the Harbor.
- `mcp_server_url` (string, optional) — MCP server URL for the Harbor.
- `name` (string, optional) — Human-readable Harbor name.
- `organization_id` (string, optional) — Organization that owns the Harbor.
- `status` (string, optional) — Storage lifecycle status. Wait for ready before using the Harbor; failed provisioning is retried automatically.
- `updated_at` (datetime, optional) — When the Harbor was last updated.

## Examples

**Request**

```json
{
  "backing_mode": "managed",
  "name": "Revenue Operations"
}
```

**Response**

```json
{
  "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"
    }
  }
}
```

**SDK Code**

```python
import requests

url = "https://app.polytomic.com/api/harbors"

payload = {
    "backing_mode": "managed",
    "name": "Revenue Operations"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://app.polytomic.com/api/harbors';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"backing_mode":"managed","name":"Revenue Operations"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.polytomic.com/api/harbors"

	payload := strings.NewReader("{\n  \"backing_mode\": \"managed\",\n  \"name\": \"Revenue Operations\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://app.polytomic.com/api/harbors")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"backing_mode\": \"managed\",\n  \"name\": \"Revenue Operations\"\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://app.polytomic.com/api/harbors")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"backing_mode\": \"managed\",\n  \"name\": \"Revenue Operations\"\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://app.polytomic.com/api/harbors', [
  'body' => '{
  "backing_mode": "managed",
  "name": "Revenue Operations"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://app.polytomic.com/api/harbors");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"backing_mode\": \"managed\",\n  \"name\": \"Revenue Operations\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "backing_mode": "managed",
  "name": "Revenue Operations"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://app.polytomic.com/api/harbors")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```