Admin

Get plugin registration

One registration with the Contract Runner's report once its check ran. Requires plugins:admin.

get/v0/admin/plugins/{registration_id}

Request

  • Base URL
    https://docs.quivr.thevibecompany.co (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

registration_idstring required

Response

Successful response

registration_idstring required
plugin_idstring required
versionstring required
endpointstring required

Base URL where the operator runs this plugin version.

manifest_digeststring required
artifact_digeststring

Artifact digest the plugin reports, recorded as information. Absent when it reports none.

contributionsstring[] required
rolesstring[] required

Roles the manifest declares it can serve, such as normalizer:application/pdf, subscription:<plugin id> or connector:<kind>. The active plan says which it serves.

state'registered' | 'validated' | 'active' | 'draining' | 'inactive' | 'rejected' required

registered while the Contract Runner checks it, then validated or rejected; active while the active plan names it. Once a later plan leaves it out it is draining while pinned_work or subscriptions is above zero, then inactive.

pinned_workinteger required

Unfinished work pinned to a Pipeline Plan that names this registration, such as the processing of a receipt, a connector run or a rebuild. Work finishes on the plan it started on, so a registration a plan change left out keeps being called until this reaches zero. For an alert-rule plugin it also counts the pending evaluations of Subscription Versions that pin its version.

subscriptionsinteger required

For an alert-rule plugin, the Subscriptions of every Organization that are not deleted, enabled or disabled, whose current Version pins this plugin version. They keep it until migrateSubscriptionEvaluators moves them; 0 for other plugins.

created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.