overlane api-key revoke | Overlane Docs

Revokes an API key. Every call reads the database, so the key fails on the very next request with token_revoked (exit 3). Revoking again changes nothing. Revoking is in the secrets autonomy class.

Usage

overlane api-key revoke [key-id] [--service URL] [--team TENANT_ID] [--dry-run] [--force]

Arguments

Argument	Required	Description
`key-id`	no	The key ID from `overlane api-key list`

Flags

Flag	Type	Required	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)
`--dry-run`	boolean	no	Print the requests and file changes this command would make, then stop. Needs no credentials.
`--force`	boolean	no	Confirm a destructive action when there is no terminal to ask on. Without it, exit 2.

Examples

overlane api-key revoke key_0123456789abcdef --force
overlane api-key revoke key_0123456789abcdef --dry-run

Behavior

Effect: destructive (deletes or reverts; needs --force without a terminal).
Needs credentials: yes. Uses the network: yes.
Supports --dry-run: yes. Accepts --force: yes.
Machine-readable description: overlane schema api-key revoke.

Result

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

{
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "tenantId": {
          "type": "string"
        },
        "key": {
          "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
        },
        "next": {
          "type": "string"
        }
      },
      "required": [
        "tenantId",
        "key",
        "next"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "dryRun": {
          "type": "boolean",
          "const": true
        },
        "service": {
          "type": "string"
        },
        "requests": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "method": {
                "type": "string"
              },
              "path": {
                "type": "string"
              },
              "body": {},
              "note": {
                "type": "string"
              }
            },
            "required": [
              "method",
              "path"
            ],
            "additionalProperties": false
          }
        },
        "commands": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "writes": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "path": {
                "type": "string"
              },
              "action": {
                "type": "string",
                "enum": [
                  "write",
                  "append",
                  "delete"
                ]
              },
              "description": {
                "type": "string"
              }
            },
            "required": [
              "path",
              "action",
              "description"
            ],
            "additionalProperties": false
          }
        },
        "notes": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "required": [
        "dryRun",
        "requests",
        "commands",
        "writes",
        "notes"
      ],
      "additionalProperties": false
    }
  ]
}

See exit codes for the status the process returns.