Skip to main content

ApiKeyListEnvelope

okbooleanrequired
meta object
watermarkstring

Opaque leak-tracing token. Safe to ignore.

Possible values: Value must match regular expression ^wm_[0-9a-f]{8}$

Example: wm_a1b2c3d4
data object[]
  • Array [
  • idstringrequired
    namestringrequired
    key_prefixstringrequired

    First 12 chars of the key. Safe to log.

    permissionsstring[]required
    ip_allowliststring[]
    is_activebooleanrequired
    created_atdate-timerequired
    expires_atdate-timenullable
    revoked_atdate-timenullable
    last_used_atdate-timenullable
  • ]
  • ApiKeyListEnvelope
    {
    "ok": true,
    "meta": {
    "watermark": "wm_a1b2c3d4"
    },
    "data": [
    {
    "id": "string",
    "name": "string",
    "key_prefix": "string",
    "permissions": [
    "string"
    ],
    "ip_allowlist": [
    "string"
    ],
    "is_active": true,
    "created_at": "2024-07-29T15:51:28.071Z",
    "expires_at": "2024-07-29T15:51:28.071Z",
    "revoked_at": "2024-07-29T15:51:28.071Z",
    "last_used_at": "2024-07-29T15:51:28.071Z"
    }
    ]
    }