overlane api-key list | Overlane Docs

Lists the team’s API keys with their prefix, scopes, project, cap, expiry, last use and whether they are revoked. The secret is shown only when a key is created or rotated.

Usage

overlane api-key list [--service URL] [--team TENANT_ID]

Flags

Flag	Type	Required	Default	Description
`--service`	string	no		The service address (default: OVERLANE_SERVICE_URL, then the project’s binding, then the hosted service)
`--team`	string	no		The team (tenant) to act on (default: the one your token belongs to)

Examples

overlane api-key list
overlane api-key list --json

Behavior

Effect: read (changes nothing).
Needs credentials: yes. Uses the network: yes.
Supports --dry-run: no. Accepts --force: no.
Machine-readable description: overlane schema api-key list.

Result

With --json (the default when stdout is not a terminal) the command prints this JSON Schema’s shape on stdout.

{
  "type": "object",
  "properties": {
    "tenantId": {
      "type": "string"
    },
    "keys": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "keyId": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "prefix": {
            "type": "string"
          },
          "scopes": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "project": {
            "type": "string"
          },
          "rateLimitPerMinute": {
            "type": "number"
          },
          "expiresAt": {
            "type": "string"
          },
          "lastUsedAt": {
            "type": "string"
          },
          "revokedAt": {
            "type": "string"
          },
          "rotatedFrom": {
            "type": "string"
          }
        },
        "required": [
          "keyId",
          "label",
          "prefix",
          "scopes",
          "expiresAt"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "tenantId",
    "keys"
  ],
  "additionalProperties": false
}

See exit codes for the status the process returns.