---
title: "Get an environment's SSH access"
url: https://docs.corefinity.com/api/reference/access/get-environment-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 an environment's SSH access

Answers how to connect to the environment and every key that can log in, grouped by username, with the level
each key comes from. `add_options` lists the levels you may add a key at.

```http
GET /api/environments/{environment}/ssh
```

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

## Path parameters

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

## Request

### curl

```bash
curl https://manage.corefinity.com/api/environments/1311/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/environments/1311/ssh');

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

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/environments/1311/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/environments/1311/ssh",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
)

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

## Responses

### 200 The environment's SSH access.

```json
{
  "add_options": [
    {
      "level": "environment",
      "login": "web",
      "owner": {
        "id": 1311,
        "name": "Production",
        "type": "environment"
      },
      "reach": {
        "clients": 0,
        "environments": 1,
        "websites": 1
      }
    },
    {
      "level": "website",
      "login": "web",
      "owner": {
        "id": 1310,
        "name": "Harbour & Finch trade",
        "type": "website"
      },
      "reach": {
        "clients": 0,
        "environments": 1,
        "websites": 1
      }
    },
    {
      "level": "company",
      "login": "web",
      "owner": {
        "id": 1204,
        "name": "Harbour & Finch",
        "type": "company"
      },
      "reach": {
        "clients": 0,
        "environments": 1,
        "websites": 1
      }
    },
    {
      "level": "user",
      "login": "eleanor-harbourfinch",
      "owner": {
        "id": 2041,
        "name": "Eleanor Finch",
        "type": "user"
      },
      "reach": {
        "clients": 0,
        "environments": 1,
        "websites": 1
      }
    }
  ],
  "add_refusals": [],
  "can_add": {
    "allowed": true,
    "refused": null
  },
  "connection": {
    "host": "ssh-northwind.example.net",
    "host_keys": {
      "changed_at": "2026-11-02T01:12:40+00:00",
      "current": [
        {
          "fingerprint": "SHA256:ExampleHostKeyEd25519FingerprintNotARealOne",
          "type": "ed25519"
        },
        {
          "fingerprint": "SHA256:ExampleHostKeyEcdsaFingerprintNotARealOne00",
          "type": "ecdsa"
        },
        {
          "fingerprint": "SHA256:ExampleHostKeyRsaFingerprintNotARealOne0000",
          "type": "rsa"
        }
      ],
      "known_hosts": [
        "[ssh-northwind.example.net]:21044 ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIAAAExampleHostKeyOnlyThisIsNotARealHostKey1",
        "[ssh-northwind.example.net]:21044 ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBExampleHostKeyOnlyThisIsNotARealHostKey2ExampleHostKeyOnlyThisIsNotARealHostKey2Exampl=",
        "[ssh-northwind.example.net]:21044 ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABgQExampleHostKeyOnlyThisIsNotARealHostKey3ExampleHostKeyOnlyThisIsNotARealHostKey3ExampleHostKeyOnlyThisIsNotARealHostKey3"
      ],
      "managed_by": "panel",
      "next": null
    },
    "port": 21044,
    "tunnel_target": "127.0.0.1:3306",
    "web_command": "ssh -p 21044 web@ssh-northwind.example.net",
    "your_login": {
      "command": "ssh -p 21044 eleanor-harbourfinch@ssh-northwind.example.net",
      "delivered": true,
      "login": "eleanor-harbourfinch",
      "state": "ready"
    }
  },
  "delivery": {
    "applied_at": "2026-11-05T09:17:02+00:00",
    "group_write": null,
    "last_error_public": null,
    "mode": "managed",
    "next_attempt_at": null,
    "not_on_new_system": false,
    "planned_for": null,
    "state": "applied",
    "verified_at": "2026-11-05T09:17:05+00:00",
    "waiting_for": null
  },
  "environment": {
    "company": {
      "id": 1204,
      "name": "Harbour & Finch"
    },
    "id": 1311,
    "name": "Production",
    "product": "corecluster",
    "site_id": 1042,
    "website": {
      "id": 1310,
      "name": "Harbour & Finch trade"
    }
  },
  "forwarding": {
    "restricted": false,
    "targets": []
  },
  "legacy": {
    "count": 1,
    "ends_on": "2026-12-09"
  },
  "logins": [
    {
      "keys": [
        {
          "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": "2026-11-04T16:20:11+00:00",
          "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
        },
        {
          "added_at": "2026-11-02T00:00:00+00:00",
          "added_by": null,
          "bits": null,
          "delivery": {
            "planned_for": null,
            "state": "applied"
          },
          "editable": false,
          "fingerprint": "SHA256:Ploa6Hz7DwoHuC3xPgwJD+qGdTytelbFQ+lXDSmu+lY",
          "id": 7290,
          "last_used_at": null,
          "legacy": {
            "ci_hint": null,
            "ends_on": "2026-12-09",
            "placed_at": null,
            "state": "legacy"
          },
          "name": "deploy@build-server",
          "removable": true,
          "restricted": false,
          "restrictions": [],
          "source": {
            "layer": "legacy",
            "owner": {
              "id": 1311,
              "name": "Production",
              "type": "environment"
            }
          },
          "type": "ssh-ed25519",
          "weak": false
        }
      ],
      "kind": "web",
      "login": "web",
      "person": null,
      "you": false
    },
    {
      "keys": [
        {
          "added_at": "2026-11-05T09:16:40+00:00",
          "added_by": {
            "former": false,
            "name": "Eleanor Finch",
            "support": false
          },
          "bits": null,
          "delivery": {
            "planned_for": null,
            "state": "applied"
          },
          "editable": true,
          "fingerprint": "SHA256:8LnkAlf64yNQsvTdVFxkoxM//vjpVpE8t+3gzVg1UjM",
          "id": 7306,
          "last_used_at": null,
          "legacy": null,
          "name": "Eleanor's laptop",
          "removable": true,
          "restricted": false,
          "restrictions": [],
          "source": {
            "layer": "user",
            "owner": {
              "id": 2041,
              "name": "Eleanor Finch",
              "type": "user"
            }
          },
          "type": "ssh-ed25519",
          "weak": false
        }
      ],
      "kind": "person",
      "login": "eleanor-harbourfinch",
      "person": {
        "former": false,
        "name": "Eleanor Finch",
        "user_id": 2041
      },
      "you": true
    }
  ],
  "managed_on": null,
  "notes": [
    "The browser terminal and AI tools connect through Corefinity, not through SSH keys or the firewall."
  ]
}
```

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