# Revoke a portal link

<div class="api-op" data-api-operation>
<div class="api-op__main">

<p class="api-endpoint"><span class="method method-post">POST</span> <code>/v1/portal/links/&#123;link&#125;/revoke</code></p>

The link can no longer be opened, and sessions opened with it end at once.

<dl class="api-facts"><div><dt>Scope</dt><dd><code>portal_links:write</code></dd></div><div><dt>Auth</dt><dd>Secret key (<code>sk_…</code>)</dd></div><div><dt>Since</dt><dd>1.0</dd></div></dl>

## Path parameters

<ul class="api-fields">
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">link</code> <span class="api-field__type">string</span> <span class="api-field__required">Required</span></p>
</li>
</ul>

## Headers

<ul class="api-fields">
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">OhAuthCat-Version</code> <span class="api-field__type">string</span></p>
Minor version; defaults to the environment's pin.
</li>
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">Idempotency-Key</code> <span class="api-field__type">string</span></p>
Honoured for 24 h; a replay returns the original response.

<p class="api-field__chips">min length 1 · max length 255</p>
</li>
</ul>

## Responses

<ul class="api-responses">
<li class="api-response"><span class="api-status api-status--ok">200</span> <span>OK <span class="api-field__type">PortalLinkInfo</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">400</span> <span>Invalid request. Codes: <a href="/errors/parameter_invalid/">parameter_invalid</a>, <a href="/errors/parameter_missing/">parameter_missing</a>, <a href="/errors/version_unsupported/">version_unsupported</a> and resource-specific codes from the catalogue. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">401</span> <span>Codes: <a href="/errors/authentication_required/">authentication_required</a>, <a href="/errors/api_key_invalid/">api_key_invalid</a>. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">403</span> <span>Codes: <a href="/errors/api_key_scope_missing/">api_key_scope_missing</a>, <a href="/errors/ip_not_allowed/">ip_not_allowed</a>, <a href="/errors/plan_limit_reached/">plan_limit_reached</a>. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">404</span> <span>Code: <a href="/errors/resource_not_found/">resource_not_found</a> (also returned for other tenants' IDs); a path no endpoint serves answers <a href="/errors/route_not_found/">route_not_found</a>. A browser GET or HEAD of an unknown path whose Accept ranks text/html above JSON gets an HTML 404 page instead, with the same status; every other client gets this JSON body. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">429</span> <span>Code: <a href="/errors/rate_limited/">rate_limited</a>. Retry-After is set. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">503</span> <span>Code: <a href="/errors/service_unavailable/">service_unavailable</a>. Retry-After is set; writes are paused. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--neutral">default</span> <span>Any other error, including <a href="/errors/internal_error/">internal_error</a>. Every code is in the error catalogue. <span class="api-field__type">Error</span></span></li>
</ul>

Errors share one shape; see the [error code catalogue](/errors/).

</div>
<div class="api-op__code">

**curl**

```sh wrap
curl -X POST \
  "https://api.ohauthcat.com/v1/portal/links/plink_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/revoke" \
  -H "Authorization: Bearer $OHAUTHCAT_API_KEY"
```

**Node**

```javascript wrap
const response = await fetch(
  "https://api.ohauthcat.com/v1/portal/links/plink_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/revoke",
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`,
    },
  },
);
const data = await response.json();
```

**Python**

```python wrap
import os
import requests

response = requests.post(
    "https://api.ohauthcat.com/v1/portal/links/plink_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/revoke",
    headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"},
)
data = response.json()
```

```json title="Response 200" wrap
{
  "completion": {
    "features": ["sso"],
    "connection": "conn_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
    "directory": "dir_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
    "object": "portal_setup_completion",
    "completed_at": "2026-01-15T09:30:00Z"
  },
  "profile": "pprof_01J9ZQ4M7K2X8V3N5B6C1D0E9F",
  "id": "plink_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
  "object": "portal_link",
  "organization_id": "org_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
  "intents": ["sso"],
  "state": "pending",
  "expires_at": "2026-01-15T09:30:00Z",
  "created_at": "2026-01-15T09:30:00Z",
  "opened_at": "2026-01-15T09:30:00Z"
}
```

</div>
</div>
