POpolytomic
Harbors

Update Harbor

Changed on

Updates a Harbor's name and description.

Renaming a managed Harbor also renames its backing Connection. Both names change together; a name conflict returns 409 Conflict and leaves both unchanged. Renaming a customer-managed Harbor preserves its Connection's name.

This operation does not change backing_mode or backing_connection_id.

put/api/harbors/{harbor_id}

Request

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

Path parameters

harbor_idstring uuid required

Unique identifier of the Harbor

Example:248df4b7-aa70-47b8-a036-33ac447e668d

Headers

X-Polytomic-Versionstring

Request body

descriptionstring

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

namestring required

Human-readable Harbor name

Example request

{
  "description": "Revenue, pipeline, and renewal data",
  "name": "Revenue Operations"
}

Response

OK

Example response

{
  "data": {
    "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

    • 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

  • e34191959c45Revision changes
    • info

      added the optional property / to the response with the status