Get your own SSH keys
Answers your personal keys, your SSH username and the environments it reaches. The first read issues your username when your account can have one; reason says why not when it cannot.
Returns
200 Your keys and username.
Fields of the 200 answer
Whether you may add a key here.
Fields
Why not. managed_elsewhere, which only an environment's answer gives, means the keys are managed on another environment of the same server (managed_on).
managed_elsewherenullFields of each item
Format: date-time.
Who added a key or made a change.
Fields
True when the person has left the company.
Null when the person has been removed, or when Corefinity support made the change for nobody by name.
True when Corefinity support added the key or made the change. name is then the person it was done for, or null.
Other places the same key is held that you can see.
Fields of each item
agencycompanywebsiteenvironmentuserlegacysystemWhere a key is held: a company, a website, an environment or a person.
Fields
The id of the company, website, environment or user.
companywebsiteenvironmentuserNull for environment and personal keys.
The key size, for RSA keys.
Where the key works so far, counted over the environments it reaches.
Fields
Environments the key works on.
Environments whose keys the Control Panel does not manage yet.
For a key being removed, environments it no longer works on.
appliedapplyingremovingfailedwaitingEnvironments the key reaches, without those in not_on_new_system.
Environments where the key, or its removal, waits for the environment to switch over or for a platform update.
How many of waiting wait for a platform update.
Whether you may rename the key or change where it applies.
The SHA-256 fingerprint, as ssh-keygen -lf prints it. Removing the key, or narrowing where it applies, asks you to send it back.
The key id the /ssh/keys/{key} endpoints take.
Format: date-time.
The level the key is held at, as you see it. agency is a key of your agency.
agencycompanywebsiteenvironmentuserlegacysystemSet for a Legacy key, else null.
quarantined is a key Corefinity has stopped from working; quarantine_reason says why.
activeremovingquarantinedThe username the key logs in with: web, or the person's own username for a personal key (null until one is issued).
Where a key is held: a company, a website, an environment or a person.
Fields
The id of the company, website, environment or user.
companywebsiteenvironmentuserHow far a key reaches.
Fields
Client companies an agency's key reaches.
Whether you may remove the key.
True when the key carries restrictions from before it was imported.
The restrictions as they are written in front of the key. Read-only.
The key type, such as ssh-ed25519, ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, ecdsa-sha2-nistp521 or ssh-rsa. A key imported from a server may carry an older type (ssh-dss) or a security-key type (sk-), which new keys may not.
ssh-ed25519ecdsa-sha2-nistp256ecdsa-sha2-nistp384ecdsa-sha2-nistp521ssh-rsassh-dss[email protected][email protected]True for a key that would be refused if it were added today.
Your username. Null while none can be issued; reason says why.
The environments your username reaches.
Fields of each item
The ssh command to connect.
An environment, with the website and company it belongs to.
Fields
Fields
At least 1.
The environment id, the {environment} these endpoints take and the owner.id of an environment key.
cse is CoreStack Enterprise.
csecorestackcoreclusterThe site row id the /corestack/sites/{site} endpoints take. Null on CoreStack Enterprise.
Fields
At least 1.
readywaiting_for_switch_overwaiting_for_platform_updatenot_switched_onfailedunmanagedWhy login is null. handle_missing means your company has no SSH handle yet, or your account belongs to no company.
handle_missingnullA ~/.ssh/config block for every environment that is ready. Null when none is.
Your user id, the owner.id of a personal key.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | 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. |
429 | rate_limited | Wait for the seconds in Retry-After. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl https://manage.corefinity.com/api/user/ssh \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json"use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->get('https://manage.corefinity.com/api/user/ssh');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/user/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);import os
import requests
res = requests.get(
"https://manage.corefinity.com/api/user/ssh",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"can_add": {
"allowed": true,
"refused": null
},
"can_have_login": true,
"keys": [
{
"added_at": "2026-11-05T09:16:40+00:00",
"added_by": {
"former": false,
"name": "Eleanor Finch",
"support": false
},
"also_granted": [],
"applies_to": null,
"bits": null,
"delivery": {
"applied": 1,
"not_on_new_system": 0,
"removed": 0,
"state": "applied",
"total": 1,
"waiting": 0,
"waiting_platform_update": 0
},
"editable": true,
"fingerprint": "SHA256:8LnkAlf64yNQsvTdVFxkoxM//vjpVpE8t+3gzVg1UjM",
"id": 7306,
"last_used_at": null,
"layer": "user",
"legacy": null,
"lifecycle": "active",
"login": "eleanor-harbourfinch",
"name": "Eleanor's laptop",
"owner": {
"id": 2041,
"name": "Eleanor Finch",
"type": "user"
},
"quarantine_reason": null,
"reach": {
"clients": 0,
"environments": 1,
"websites": 1
},
"removable": true,
"restricted": false,
"restrictions": [],
"type": "ssh-ed25519",
"weak": false
}
],
"login": {
"handle": "harbourfinch",
"issued_at": "2026-11-03T10:01:58+00:00",
"login": "eleanor-harbourfinch",
"uid": 40118
},
"reach": [
{
"command": "ssh -p 21044 [email protected]",
"environment": {
"company": {
"id": 1204,
"name": "Harbour & Finch"
},
"id": 1311,
"name": "Production",
"product": "corecluster",
"site_id": 1042,
"website": {
"id": 1310,
"name": "Harbour & Finch trade"
}
},
"host": "ssh-northwind.example.net",
"port": 21044,
"state": "ready"
}
],
"reason": null,
"ssh_config": "Host harbourandfinch-example-com-production\n HostName ssh-northwind.example.net\n Port 21044\n User eleanor-harbourfinch\n",
"user_id": 2041
}{
"message": "Unauthenticated."
}{
"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"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}