at.happyproto.admin.rotateEncryptionKey
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.
Details · procedure
| Kind | procedure |
|---|---|
| Authority | admin.happyproto.at |
| Indexed |
Procedure
procedure · POSTInput
application/jsonThe instance's id, a UUID.
A UUID. Repeating a request with the same key replays its answer.
Output
application/jsonErrors
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
Another operation is in progress for the instance.
RotationInProgress
The instance is already part-way through a rotation: its old key is not retired yet.
InstanceStopped
The instance is stopped. Start it first.
NotLive
The instance has not gone live yet.
RotationUnsupported
The instance's HappyView cannot report a key rotation. Upgrade it first.
AgentUnreachable
The instance's host did not answer, so the provisioner could not check it.
NotSettled
The instance isn't running what an apply would send it now: it's failed, or a change such as a version bump hasn't been applied. Retry the instance first.
Upstream
The provisioner is unreachable, not configured, or answered with an error it does not explain to callers.
Similar lexicons
semantic matchLexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.
-
Where an instance's encryption key is in its rotation, and whether a rotation can start now. Staff only.