API ReferenceHarbors

Update Harbor Context

Beta
Replaces one Harbor context document. The request replaces the title, description, and content in one operation.

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

Request

This endpoint expects an object.
contentstringRequired

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

titlestringRequired

Human-readable context title. Maximum 200 characters.

descriptionstringOptional
Short summary of the context document. Maximum 1,000 characters.

Response

OK
dataobjectOptional

Errors

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