Get a company's SSH keys
Answers the keys held at the company, how far they reach and, for a client of an agency, the agency's keys that reach it. Your role needs the View Company SSH Keys permission.
Path parameters
The id of a company you belong to or manage. Digits only. At least 1.
Returns
200 The company's keys.
Fields of the 200 answer
The clients of an agency. Null unless the company is an agency with clients.
Whether you may add a company key.
Fields
The sentence a forbidden add is refused with.
Why not. forbidden means your role lacks the Create Company SSH Keys permission.
forbiddennullFields
The company's SSH handle, the first part of its people's usernames.
The company's own keys.
Fields 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 agency's keys that reach this company. Read-only.
Fields 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.
The company's Legacy keys, counted.
Fields
Format: date.
How far the keys here reach, with the environments.
Fields
Fields of each item
Fields
At least 1.
csecorestackcoreclusterFields
At least 1.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | forbidden | The person is not allowed to do this. |
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. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl https://manage.corefinity.com/api/companies/1204/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/companies/1204/ssh');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/companies/1204/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/companies/1204/ssh",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"agency": null,
"can_add": {
"allowed": true,
"message": null,
"refused": null
},
"company": {
"handle": "harbourfinch",
"id": 1204,
"is_agency": false,
"name": "Harbour & Finch"
},
"grants": [
{
"added_at": "2026-11-03T10:02:44+00:00",
"added_by": {
"former": false,
"name": "Eleanor Finch",
"support": false
},
"also_granted": [],
"applies_to": {
"environment_ids": [],
"mode": "all"
},
"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:o6poLLVqPDVYtxLTdagh8mUo96coeRXfX7Uxorxr158",
"id": 7305,
"last_used_at": "2026-11-04T16:20:11+00:00",
"layer": "company",
"legacy": null,
"lifecycle": "active",
"login": "web",
"name": "Office workstation",
"owner": {
"id": 1204,
"name": "Harbour & Finch",
"type": "company"
},
"quarantine_reason": null,
"reach": {
"clients": 0,
"environments": 1,
"websites": 1
},
"removable": true,
"restricted": false,
"restrictions": [],
"type": "ssh-ed25519",
"weak": false
}
],
"inherited": [],
"legacy": {
"count": 1,
"ends_on": "2026-12-09",
"environments": 1
},
"reach": {
"clients": 0,
"environments": 1,
"items": [
{
"company": {
"id": 1204,
"name": "Harbour & Finch"
},
"id": 1311,
"name": "Production",
"product": "corecluster",
"site_id": 1042,
"website": {
"id": 1310,
"name": "Harbour & Finch trade"
}
}
],
"websites": 1
}
}{
"message": "Unauthenticated."
}{
"code": "forbidden",
"field": null,
"message": "You need the View Company SSH Keys permission to do this. An owner of your company can grant it in Roles.",
"permission": "viewCompanySSHKeys",
"reason": "forbidden"
}{
"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
}