Skip to main content

CatalogInstallation

An installation bound to a listing, with the release record as inspected.

plugin_idPlugin Id (string)required

The bound installation.

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

listing objectrequired

One listed release as an operator sees it: consent facts, no addresses.

bundle_idBundle Id (string)required

Bundle identity the release belongs to.

bundle_versionBundle Version (string)required

Bundle version the release carries.

title object

Display title, if any.

anyOf
string
publisherPublisher (string)required

Publisher that signed the release.

sequenceSequence (integer)required

Publisher release sequence.

release_digestRelease Digest (string)required

Digest of the signed claims, as inspection reviews them.

runtime_platform object

Exact artifact family of a runtime-bearing release; None for a plain one.

anyOf
string
artifact_sha256Artifact Sha256 (string)required

Digest of the executable artifact.

artifact_bytesArtifact Bytes (integer)required

Signed artifact size in bytes.

transfer_bytesTransfer Bytes (integer)required

Everything an install transfers: the artifact plus, for a runtime-bearing release, every wheel it lists.

platformsstring[]required

Operating systems supported.

skulk_build_sha256Skulk Build Sha256 (string)required

Skulk build the release binds to.

permissionsstring[]required

Signed permission summaries.

descriptorsstring[]required

Qualified capability ids.

surfacesstring[]required

Titles of declared surfaces.

operationsOperations (boolean)required

Whether durable operations are declared.

steward_risksstring[]required

Steward exposure risk classes: observation, billable, effect.

expires_atExpires At (integer)required

Release expiry as a Unix timestamp.

matches_hostMatches Host (boolean)required

Whether this host's Skulk build and platform match the release.

source objectrequired

Source readiness after binding.

revisionRevision (integer)required

Current source revision, zero if unconfigured.

Possible values: >= 0

configuredConfigured (boolean)required

Whether a private release source is configured.

credential_reference object

Opaque feed credential reference.

anyOf
string

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

credential_readyCredential Ready (boolean)required

Whether the configured credential is readable, or the source is anonymous.

trust_revision object

Configured publisher trust revision.

anyOf
integer
review objectrequired

The verified release record at the listed feed; it matches the listing.

runtime_digestRuntime Digest (string)required

Digest of all signed runtime claims.

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

source_revisionSource Revision (integer)required

Reviewed owner source revision.

Possible values: >= 1

publisherPublisher (string)required

Trusted publisher identity.

bundle_idBundle Id (string)required

Signed stable plugin identity.

versionVersion (string)required

Signed plugin release version.

sequenceSequence (integer)required

Signed publisher release sequence.

Possible values: >= 1

platformPlatform (string)required

Verified compatible host platform.

Possible values: <= 64 characters, Value must match regular expression ^[a-z0-9]+(?:[.-][a-z0-9_]+)*$

python_requiresPython Requires (string)required

Signed supported Python version range.

skulk_build_sha256Skulk Build Sha256 (string)required

Exact qualified Skulk build.

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

permissionsstring[]required

Signed declared plugin permissions.

artifact_bytesArtifact Bytes (integer)required

Total signed bundle and wheel byte count.

Possible values: >= 1

expires_atExpires At (integer)required

Signed release expiry as Unix seconds.

CatalogInstallation
{
"plugin_id": "string",
"listing": {
"bundle_id": "string",
"bundle_version": "string",
"title": "string",
"publisher": "string",
"sequence": 0,
"release_digest": "string",
"runtime_platform": "string",
"artifact_sha256": "string",
"artifact_bytes": 0,
"transfer_bytes": 0,
"platforms": [
"string"
],
"skulk_build_sha256": "string",
"permissions": [
"string"
],
"descriptors": [
"string"
],
"surfaces": [
"string"
],
"operations": true,
"steward_risks": [
"string"
],
"expires_at": 0,
"matches_host": true
},
"source": {
"revision": 0,
"configured": true,
"credential_reference": "string",
"credential_ready": true,
"trust_revision": 0
},
"review": {
"runtime_digest": "string",
"source_revision": 0,
"publisher": "string",
"bundle_id": "string",
"version": "string",
"sequence": 0,
"platform": "string",
"python_requires": "string",
"skulk_build_sha256": "string",
"permissions": [
"string"
],
"artifact_bytes": 0,
"expires_at": 0
}
}