at.happyproto.admin.getEncryptionKey
Where an instance's encryption key is in its rotation, and whether a rotation can start now. Staff only.
Details · query
| Kind | query |
|---|---|
| Authority | admin.happyproto.at |
| Indexed |
Checks
Validunlimited-stringdefs.main.parameters.properties.idNo maxLength, maxGraphemes or format limits this string.
{
"$type": "com.atproto.lexicon.schema",
"defs": {
"main": {
"description": "Where an instance's encryption key is in its rotation, and whether a rotation can start now. Staff only.",
"errors": [
{
"description": "This endpoint requires an authenticated caller.",
"name": "AuthRequired"
},
{
"description": "The caller is not HappyProto staff, or the provisioner does not treat them as staff.",
"name": "Forbidden"
},
{
"description": "The input was malformed, or the provisioner refused it as malformed.",
"name": "InvalidRequest"
},
{
"description": "No such instance, or it has been deleted.",
"name": "NotFound"
},
{
"description": "Passed through from the provisioner.",
"name": "InvalidSlug"
},
{
"description": "Passed through from the provisioner.",
"name": "SlugTaken"
},
{
"description": "Passed through from the provisioner.",
"name": "NotEntitled"
},
{
"description": "Passed through from the provisioner.",
"name": "InstanceLimit"
},
{
"description": "Passed through from the provisioner.",
"name": "NoCapacity"
},
{
"description": "Passed through from the provisioner.",
"name": "OperationInProgress"
},
{
"description": "Passed through from the provisioner.",
"name": "RotationInProgress"
},
{
"description": "Passed through from the provisioner.",
"name": "InstanceStopped"
},
{
"description": "Passed through from the provisioner.",
"name": "NotLive"
},
{
"description": "Passed through from the provisioner.",
"name": "RotationUnsupported"
},
{
"description": "Passed through from the provisioner.",
"name": "AgentUnreachable"
},
{
"description": "Passed through from the provisioner.",
"name": "NotSettled"
},
{
"description": "The provisioner is unreachable, not configured, or answered with an error it does not explain to callers.",
"name": "Upstream"
}
],
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"encryptionKey": {
"ref": "at.happyproto.admin.defs#encryptionKey",
"type": "ref"
}
},
"required": [
"encryptionKey"
],
"type": "object"
}
},
"parameters": {
"properties": {
"id": {
"description": "The instance's id, a UUID.",
"type": "string"
}
},
"required": [
"id"
],
"type": "params"
},
"type": "query"
}
},
"id": "at.happyproto.admin.getEncryptionKey",
"lexicon": 1
}