Skip to navigation
API ReferenceHarbors

Update Harbor Context

Beta

Replaces one Harbor context document.

Each successful request publishes the next immutable version. You can omit change_note.

A direct publication leaves an existing draft unchanged.

Authentication

AuthorizationBearer
Bearer user API key
OR
AuthorizationBasic

Basic organization-scoped API key

Path parameters

harbor_idstringRequiredformat: "uuid"
Unique identifier of the Harbor
context_idstringRequiredformat: "uuid"
Unique identifier of the context document

Headers

X-Polytomic-VersionstringOptional
X-Polytomic-Harbor-SessionstringOptional

Harbor session token; when supplied, the session must be active and bound to this credential and Harbor.

X-Polytomic-Activity-Request-IDstringOptional

New nonzero UUID for each request, required for scoped credentials; a reused value is rejected.

Request

This endpoint expects an object.
contentstringRequired

Plain-text context content. Maximum 20,000 characters.

titlestringRequired

Human-readable context title. Maximum 200 characters.

change_notestring or nullOptional
Optional note describing this published change
descriptionstringOptional
Short summary of the context document. Maximum 1,000 characters.

Response

OK
dataobjectOptional
The context document

Errors

403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error