social.coves.aggregator.getApiKey

coves.social

{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Get information about the authenticated aggregator's API key. Note: The actual key value is NEVER returned - only metadata about the key.",
      "errors": [
        {
          "description": "Authentication is required to get API key info",
          "name": "AuthenticationRequired"
        },
        {
          "description": "Only registered aggregators can get API key info",
          "name": "AggregatorRequired"
        },
        {
          "description": "Aggregator not found",
          "name": "AggregatorNotFound"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "hasKey": {
              "description": "Whether the aggregator has an API key (active or revoked)",
              "type": "boolean"
            },
            "keyInfo": {
              "description": "API key metadata. Only present if hasKey is true.",
              "ref": "social.coves.aggregator.defs#apiKeyView",
              "type": "ref"
            }
          },
          "required": [
            "hasKey"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "description": "No parameters required. Returns key info for the authenticated aggregator.",
        "properties": {},
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "social.coves.aggregator.getApiKey",
  "lexicon": 1
}

Validate Record

Validate a record against social.coves.aggregator.getApiKey

Validation Options
Automatically resolve and include external schemas for full validation
Treat any remaining unresolved references as valid

Metadata

DID
did:web:coves.social
CID
bafyreif6foh5ygw7mgeqze2ztfmu2t33nc5x2j4n52jtqm6aysm2eod5oq
Indexed At
2026-07-24 05:18 UTC
AT-URI
at://did:web:coves.social/com.atproto.lexicon.schema/social.coves.aggregator.getApiKey

Referenced Schemas (1)

Similar Lexicons

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

  • Create an API key for the authenticated aggregator. Requires OAuth authentication. The API key is returned ONCE and cannot be retrieved again. Store it securely.

  • Revoke the authenticated aggregator's API key. After revocation, the aggregator must complete OAuth flow again to create a new API key. This action cannot be undone.

  • List every API key belonging to the authenticated account, most-recently-created first. The owning DID is derived from the credential presented (session cookie or `Authorization: Bearer cocore-...`); there is no way to …

Lexicon Garden

@