---
title: "Get a website's SSH keys"
url: https://docs.corefinity.com/api/reference/access/get-website-ssh
type: endpoint
last_updated: 2026-11-13
feature: ssh-keys
related:
  - https://docs.corefinity.com/guides/sites/access-and-security/ssh-keys.md
---
# Get a website's SSH keys

Answers the keys held at the website, the keys it inherits from its company and agency, and its environments
with the state of each one's keys.

```http
GET /api/websites/{website}/ssh
```

- Scope: `read`
- Rate limit: 120 a minute
- Try it in the console: on

## Path parameters

- `website` (integer, required): The id of a CoreStack Enterprise website. Not the same number as a site row id.

## Request

### curl

```bash
curl https://manage.corefinity.com/api/websites/1310/ssh \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
```

### PHP

```php
use Illuminate\Support\Facades\Http;

$response = Http::withToken(env('COREFINITY_TOKEN'))
    ->acceptJson()
    ->get('https://manage.corefinity.com/api/websites/1310/ssh');

$data = $response->json();
```

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/websites/1310/ssh', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
    Accept: 'application/json',
  },
});

// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);
```

### Python

```python
import os
import requests

res = requests.get(
    "https://manage.corefinity.com/api/websites/1310/ssh",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
)

data = res.json() if res.content else None
```

## Responses

### 200 The website's keys.

```json
{
  "can_add": {
    "allowed": true,
    "refused": null
  },
  "environments": [
    {
      "delivery_state": "applied",
      "id": 1311,
      "name": "Production",
      "site_id": 1042
    }
  ],
  "grants": [],
  "inherited": [
    {
      "added_at": "2026-11-03T10:02:44+00:00",
      "added_by": {
        "former": false,
        "name": "Eleanor Finch",
        "support": false
      },
      "bits": null,
      "delivery": {
        "planned_for": null,
        "state": "applied"
      },
      "editable": false,
      "fingerprint": "SHA256:o6poLLVqPDVYtxLTdagh8mUo96coeRXfX7Uxorxr158",
      "id": 7305,
      "last_used_at": null,
      "legacy": null,
      "name": "Office workstation",
      "removable": false,
      "restricted": false,
      "restrictions": [],
      "source": {
        "layer": "company",
        "owner": {
          "id": 1204,
          "name": "Harbour & Finch",
          "type": "company"
        }
      },
      "type": "ssh-ed25519",
      "weak": false
    }
  ],
  "website": {
    "company": {
      "id": 1204,
      "name": "Harbour & Finch"
    },
    "id": 1310,
    "name": "Harbour & Finch trade",
    "product": "corecluster"
  }
}
```

### 401 No token, or a token that is not valid.

```json
{
  "message": "Unauthenticated."
}
```

### 403 The token lacks the scope this endpoint needs. `scope` names it.

```json
{
  "code": "scope_required",
  "message": "This access token does not have the destructive scope this needs. Use a token with the destructive scope.",
  "reason": "scope_required",
  "scope": "destructive"
}
```

### 404 The id does not exist or is something you cannot reach (`not_found`; both answer the same body), or SSH keys are not on for it (`feature_off`, which on a key change may add `field: null`).

```json
{
  "code": "feature_off",
  "message": "Not found.",
  "reason": "feature_off"
}
```

### 429 Too many requests (`rate_limited`). Wait for the number of seconds in `Retry-After`, which `retry_after_seconds` repeats.

```json
{
  "code": "rate_limited",
  "message": "Too many requests. Try again in 60 seconds.",
  "reason": "rate_limited",
  "retry_after_seconds": 60
}
```

## If it is refused

| Status | Reason | What to do |
|---|---|---|
| 401 |  | Send a valid token as `Authorization: Bearer <token>`. |
| 403 | `scope_required` | Use a token with the scope named in `scope`. |
| 404 | `feature_off` | This feature is not on for your organisation yet. |
| 404 | `not_found` | Not found. |
| 429 | `rate_limited` | Wait for the seconds in `Retry-After`. |

## The same task elsewhere

- Guide: [SSH keys](https://docs.corefinity.com/guides/sites/access-and-security/ssh-keys.md)
