Skip to main content

ManagedInstallation

Bounded local desired state and process observation, with no paths or secrets.

plugin_idPlugin Id (string)required

Stable local installed-plugin identifier.

Possible values: Value must match regular expression ^managed\.[a-z0-9][a-z0-9._-]{0,80}$

release object

Name, version and publisher of the selected signed release, read from its staged metadata; absent before a release is staged or when that metadata is unreadable.

anyOf
bundle_idBundle Id (string)required

Signed capability bundle identifier, such as foxlight.video-studio.

Possible values: non-empty and <= 128 characters

title object

Human-readable bundle title from the signed manifest, when it declares one.

anyOf
string

Possible values: non-empty and <= 128 characters

bundle_versionBundle Version (string)required

Bundle version from the signed manifest.

Possible values: non-empty and <= 64 characters

publisherPublisher (string)required

Identifier of the publisher that signed the release.

Possible values: non-empty and <= 64 characters

sequenceSequence (integer)required

The publisher's increasing release sequence number.

Possible values: >= 1

error_code object

Sanitized local installation failure class.

anyOf
string

Possible values: [initializing, installation_unavailable, service_unavailable, attachment_recovery_required]

operation_id object

Pending or selected local operation, for reconnect without resubmission.

anyOf
string

Possible values: Value must match regular expression ^[a-f0-9]{32}$

operation_state object

Current status of the referenced local operation.

anyOf
string

Possible values: [accepted, applying, complete, failed, recovery_required]

selected_digest object

Desired signed runtime generation.

anyOf
string

Possible values: Value must match regular expression ^[a-f0-9]{64}$

selection_revisionSelection Revision (integer)

Revision of the selected runtime, or zero before selection.

Possible values: >= 0

Default value: 0
enabledEnabled (boolean)

Whether the selected runtime is enabled.

Default value: false
uninstalledUninstalled (boolean)

Published uninstall intent; retained state remains available for cleanup and explicit reinstallation.

Default value: false
service object

Observed process health, independent of capability readiness.

anyOf
service_instanceService Instance (string)required

Unique launcher lifetime identifier.

observed_atObserved At (number)required

Unix observation time; old records are stale.

stateServiceProcessState (string)required

Observed local owner process state, independent of desired selection.

Possible values: [verifying, running, stopping, stopped, failed]

selected_digest objectrequired

Desired selected generation.

anyOf
string

Possible values: Value must match regular expression ^[a-f0-9]{64}$

active_digest objectrequired

Generation owned by this launcher.

anyOf
string

Possible values: Value must match regular expression ^[a-f0-9]{64}$

error_code object

Sanitized actionable failure class.

anyOf
string

Possible values: [verification_failed, owner_exited, ownership_busy, service_failed]

output_bytesOutput Bytes (integer)required

Discarded owner output volume; no payloads.

Possible values: >= 0

staleStale (boolean)required

Whether the process observation is absent or stale.

ManagedInstallation
{
"plugin_id": "string",
"release": {
"bundle_id": "string",
"title": "string",
"bundle_version": "string",
"publisher": "string",
"sequence": 0
},
"error_code": "initializing",
"operation_id": "string",
"operation_state": "accepted",
"selected_digest": "string",
"selection_revision": 0,
"enabled": false,
"uninstalled": false,
"service": {
"service_instance": "string",
"observed_at": 0,
"state": "verifying",
"selected_digest": "string",
"active_digest": "string",
"error_code": "verification_failed",
"output_bytes": 0
},
"stale": true
}