Applications

Update the state

Convenience alias for changing the lifecycle state alone. Equivalent to a partial update carrying only `state`.

Required scope applications:edit

patch/applications/{id}/state

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

stateenum<string>required

Lifecycle state of the application within the inventory.

Available options: ACTIVE, ARCHIVED, DISCOVERED, REJECTED

Response200 · application/json

The updated application record.

idstring<uuid>required

Unique identifier of the application.

namestringrequired

Display name of the application.

descriptionstring | null

Short free-text description.

logostring | null

URL of the application icon.

memostring | null

Free-form internal note.

stateenum<string>required

Lifecycle state of the application within the inventory.

Available options: ACTIVE, ARCHIVED, DISCOVERED, REJECTED

criticalitystring | null

Business criticality assigned to the application.

hostingTypestring | null

How the application is hosted.

accessUrlstring | null

URL users open to reach the application.

usageActivatedboolean

Whether usage tracking is enabled for this application.

desktopApplicationNamesstring[]

Desktop executables attributed to this application.

supportobject

Support contact details published for the application.

authenticationobject

How users authenticate against the application.

categoryobject | null

Category the application belongs to.

vendorobject | null

Vendor publishing the application.

tagsany[]

Tags attached to the application.

ownersany[]

Members responsible for the application.

lifecycleobject

Lifecycle milestone dates of the application.

customFieldsany[]

Workspace custom fields and their values.

updatedAtstring<date-time>

Timestamp of the last change, usable for change detection.