Applications

Update a document

Partial update of a document. `url` is immutable — delete and recreate the document to point it somewhere else.

Required scope applications:edit

patch/applications/{id}/documents/{documentId}

Authorizations

Authorizationstringrequired

Authorization header carrying a workspace API key, as “Bearer kbn_live_…”. The X-Api-Key header is accepted equivalently.

Path parameters

idstring<uuid>required

Identifier of the application. Must belong to the workspace the key is bound to.

documentIdstring<uuid>required

Identifier of the document.

Bodyapplication/json

documentTypeenum<string>

Kind of document.

Available options: data_policy, security_policy, technical_documents

titlestring

Title of the document.

descriptionstring

Short description of the document.

publishedboolean

Whether the document is visible to end users.

Response200 · application/json

The updated document.

idstring<uuid>required

Identifier of the document.

documentTypeenum<string>required

Kind of document.

Available options: data_policy, security_policy, technical_documents

titlestringrequired

Title of the document.

descriptionstring | null

Short description of the document.

publishedboolean

Whether the document is visible to end users.

urlstring<uri>required

URL the document is referenced by. Immutable once created.

createdAtstring<date-time>

Timestamp the document was referenced.