Applications

Create a document

Reference a new document on the application by its URL.

Required scope applications:edit

post/applications/{id}/documents

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.

Bodyapplication/json

documentTypeenum<string>required

Kind of document.

Available options: data_policy, security_policy, technical_documents

titlestringrequired

Title of the document.

descriptionstring

Short description of the document.

publishedboolean

Whether the document is visible to end users.

urlstring<uri>required

URL the document lives at. Immutable once created.

Response201 · application/json

The document was created.

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.