---
title: "overlane connector revoke"
description: "Revoke a connection and delete its stored secrets"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.overlane.app/llms.txt
> Use this file to discover all available pages before exploring further.

# overlane connector revoke

{/* Generated by apps/docs/scripts/generate.mjs (CLI pages from the command registry in packages/cli). Do not edit; run `pnpm --filter @overlane/docs gen`. */}

Revokes the connection: the sealed credential and any webhook secret are deleted from the vault and the entries stay as tombstones. Calls through the connection then fail with not_connected. Revoking again changes nothing. This is in the secrets autonomy class.

## Usage

```sh
overlane connector revoke [connection-id] [--service URL] [--team TENANT_ID] [--dry-run] [--force]
```

## Arguments

| Argument | Required | Description |
| --- | --- | --- |
| `connection-id` | no | The connection ID from `overlane connector status` |

## 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) |
| `--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

```sh
overlane connector revoke cnx_0123456789abcdef --force
overlane connector revoke cnx_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 connector revoke`.

## Result

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

```json
{
  "anyOf": [
    {
      "type": "object",
      "properties": {
        "tenantId": {
          "type": "string"
        },
        "connection": {
          "type": "object",
          "properties": {
            "connectionId": {
              "type": "string"
            },
            "provider": {
              "type": "string"
            },
            "status": {
              "type": "string"
            },
            "label": {
              "type": "string"
            },
            "kind": {
              "type": "string"
            },
            "purpose": {
              "type": "string"
            },
            "fingerprint": {
              "type": "string"
            },
            "scopes": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "config": {
              "type": "object",
              "propertyNames": {
                "type": "string"
              },
              "additionalProperties": {
                "type": "string"
              }
            },
            "project": {
              "type": "string"
            },
            "createdAt": {
              "type": "string"
            },
            "revokedAt": {
              "type": "string"
            }
          },
          "required": [
            "connectionId",
            "provider",
            "status",
            "label",
            "kind",
            "purpose",
            "fingerprint",
            "scopes",
            "config",
            "createdAt"
          ],
          "additionalProperties": false
        },
        "next": {
          "type": "string"
        }
      },
      "required": [
        "tenantId",
        "connection",
        "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](/cli/#exit-codes) for the status the process returns.

Source: https://docs.overlane.app/cli/connector-revoke/index.mdx