Lexicon Garden

at.happyproto.admin.getEncryptionKey

Where an instance's encryption key is in its rotation, and whether a rotation can start now. Staff only.

Repository @happyproto.at did:plc:mo7vq4jbioxwafy5zkcc3eux namespace authority
Details · query
Kindquery
Authorityadmin.happyproto.at
Indexed
Compare Edit in builder → Fork →

Query

query · GET

Parameters

query string

id

requiredstring

The instance's id, a UUID.

Output

application/json

Errors

AuthRequired

This endpoint requires an authenticated caller.

Forbidden

The caller is not HappyProto staff, or the provisioner does not treat them as staff.

InvalidRequest

The input was malformed, or the provisioner refused it as malformed.

NotFound

No such instance, or it has been deleted.

InvalidSlug

Passed through from the provisioner.

SlugTaken

Passed through from the provisioner.

NotEntitled

Passed through from the provisioner.

InstanceLimit

Passed through from the provisioner.

NoCapacity

Passed through from the provisioner.

OperationInProgress

Passed through from the provisioner.

RotationInProgress

Passed through from the provisioner.

InstanceStopped

Passed through from the provisioner.

NotLive

Passed through from the provisioner.

RotationUnsupported

Passed through from the provisioner.

AgentUnreachable

Passed through from the provisioner.

NotSettled

Passed through from the provisioner.

Upstream

The provisioner is unreachable, not configured, or answered with an error it does not explain to callers.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • at.happyproto.admin.rotateEncryptionKey

    procedure

    Give an instance a new encryption key. The old key stays beside it while HappyView re-seals what it sealed, and is then retired on its own. Staff only.