CorefinityCorefinityDocs
Open the Control PanelControl Panel
SSH keys · 1 of 14

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.

GET/api/companies/{company}/ssh

Path parameters

companyintegerRequired

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
agencyobject or any or nullRequired

The clients of an agency. Null unless the company is an agency with clients.

can_addobjectRequired

Whether you may add a company key.

Fields
allowedbooleanRequired
messagestring or nullRequired

The sentence a forbidden add is refused with.

refusedstring or nullRequired

Why not. forbidden means your role lacks the Create Company SSH Keys permission.

forbiddennull
companyobjectRequired
Fields
handlestring or nullRequired

The company's SSH handle, the first part of its people's usernames.

idintegerRequired
is_agencybooleanRequired
namestringRequired
grantsarray of objectsRequired

The company's own keys.

Fields of each item
added_atstringRequired

Format: date-time.

added_byobjectRequired

Who added a key or made a change.

Fields
formerbooleanRequired

True when the person has left the company.

namestring or nullRequired

Null when the person has been removed, or when Corefinity support made the change for nobody by name.

supportbooleanRequired

True when Corefinity support added the key or made the change. name is then the person it was done for, or null.

also_grantedarray of objectsRequired

Other places the same key is held that you can see.

Fields of each item
environmentsintegerRequired
layerstringRequired
agencycompanywebsiteenvironmentuserlegacysystem
ownerobjectRequired

Where a key is held: a company, a website, an environment or a person.

Fields
idintegerRequired

The id of the company, website, environment or user.

namestringRequired
typestringRequired
companywebsiteenvironmentuser
applies_toobject or any or nullRequired

Null for environment and personal keys.

bitsinteger or nullRequired

The key size, for RSA keys.

deliveryobjectRequired

Where the key works so far, counted over the environments it reaches.

Fields
appliedintegerRequired

Environments the key works on.

not_on_new_systemintegerRequired

Environments whose keys the Control Panel does not manage yet.

removedintegerRequired

For a key being removed, environments it no longer works on.

statestringRequired
appliedapplyingremovingfailedwaiting
totalintegerRequired

Environments the key reaches, without those in not_on_new_system.

waitingintegerRequired

Environments where the key, or its removal, waits for the environment to switch over or for a platform update.

waiting_platform_updateintegerRequired

How many of waiting wait for a platform update.

editablebooleanRequired

Whether you may rename the key or change where it applies.

fingerprintstringRequired

The SHA-256 fingerprint, as ssh-keygen -lf prints it. Removing the key, or narrowing where it applies, asks you to send it back.

idintegerRequired

The key id the /ssh/keys/{key} endpoints take.

last_used_atstring or nullRequired

Format: date-time.

layerstringRequired

The level the key is held at, as you see it. agency is a key of your agency.

agencycompanywebsiteenvironmentuserlegacysystem
legacyobject or any or nullRequired

Set for a Legacy key, else null.

lifecyclestringRequired

quarantined is a key Corefinity has stopped from working; quarantine_reason says why.

activeremovingquarantined
loginstring or nullRequired

The username the key logs in with: web, or the person's own username for a personal key (null until one is issued).

namestringRequired
ownerobjectRequired

Where a key is held: a company, a website, an environment or a person.

Fields
idintegerRequired

The id of the company, website, environment or user.

namestringRequired
typestringRequired
companywebsiteenvironmentuser
quarantine_reasonstring or nullRequired
reachobjectRequired

How far a key reaches.

Fields
clientsintegerRequired

Client companies an agency's key reaches.

environmentsintegerRequired
websitesintegerRequired
removablebooleanRequired

Whether you may remove the key.

restrictedbooleanRequired

True when the key carries restrictions from before it was imported.

restrictionsarray of stringsRequired

The restrictions as they are written in front of the key. Read-only.

typestringRequired

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]
weakbooleanRequired

True for a key that would be refused if it were added today.

inheritedarray of objectsRequired

Your agency's keys that reach this company. Read-only.

Fields of each item
added_atstringRequired

Format: date-time.

added_byobjectRequired

Who added a key or made a change.

Fields
formerbooleanRequired

True when the person has left the company.

namestring or nullRequired

Null when the person has been removed, or when Corefinity support made the change for nobody by name.

supportbooleanRequired

True when Corefinity support added the key or made the change. name is then the person it was done for, or null.

also_grantedarray of objectsRequired

Other places the same key is held that you can see.

Fields of each item
environmentsintegerRequired
layerstringRequired
agencycompanywebsiteenvironmentuserlegacysystem
ownerobjectRequired

Where a key is held: a company, a website, an environment or a person.

Fields
idintegerRequired

The id of the company, website, environment or user.

namestringRequired
typestringRequired
companywebsiteenvironmentuser
applies_toobject or any or nullRequired

Null for environment and personal keys.

bitsinteger or nullRequired

The key size, for RSA keys.

deliveryobjectRequired

Where the key works so far, counted over the environments it reaches.

Fields
appliedintegerRequired

Environments the key works on.

not_on_new_systemintegerRequired

Environments whose keys the Control Panel does not manage yet.

removedintegerRequired

For a key being removed, environments it no longer works on.

statestringRequired
appliedapplyingremovingfailedwaiting
totalintegerRequired

Environments the key reaches, without those in not_on_new_system.

waitingintegerRequired

Environments where the key, or its removal, waits for the environment to switch over or for a platform update.

waiting_platform_updateintegerRequired

How many of waiting wait for a platform update.

editablebooleanRequired

Whether you may rename the key or change where it applies.

fingerprintstringRequired

The SHA-256 fingerprint, as ssh-keygen -lf prints it. Removing the key, or narrowing where it applies, asks you to send it back.

idintegerRequired

The key id the /ssh/keys/{key} endpoints take.

last_used_atstring or nullRequired

Format: date-time.

layerstringRequired

The level the key is held at, as you see it. agency is a key of your agency.

agencycompanywebsiteenvironmentuserlegacysystem
legacyobject or any or nullRequired

Set for a Legacy key, else null.

lifecyclestringRequired

quarantined is a key Corefinity has stopped from working; quarantine_reason says why.

activeremovingquarantined
loginstring or nullRequired

The username the key logs in with: web, or the person's own username for a personal key (null until one is issued).

namestringRequired
ownerobjectRequired

Where a key is held: a company, a website, an environment or a person.

Fields
idintegerRequired

The id of the company, website, environment or user.

namestringRequired
typestringRequired
companywebsiteenvironmentuser
quarantine_reasonstring or nullRequired
reachobjectRequired

How far a key reaches.

Fields
clientsintegerRequired

Client companies an agency's key reaches.

environmentsintegerRequired
websitesintegerRequired
removablebooleanRequired

Whether you may remove the key.

restrictedbooleanRequired

True when the key carries restrictions from before it was imported.

restrictionsarray of stringsRequired

The restrictions as they are written in front of the key. Read-only.

typestringRequired

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]
weakbooleanRequired

True for a key that would be refused if it were added today.

legacyobjectRequired

The company's Legacy keys, counted.

Fields
countintegerRequired
ends_onstring or nullRequired

Format: date.

environmentsintegerRequired
reachobjectRequired

How far the keys here reach, with the environments.

Fields
clientsintegerRequired
environmentsintegerRequired
itemsarray of objectsRequired
Fields of each item
companyobjectRequired
Fields
idintegerRequired

At least 1.

namestringRequired
idintegerRequired
namestringRequired
productstringRequired
csecorestackcorecluster
site_idinteger or nullRequired
websiteobjectRequired
Fields
idintegerRequired

At least 1.

namestringRequired
websitesintegerRequired

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403forbiddenThe person is not allowed to do this.
403scope_requiredUse a token with the scope named in scope.
404feature_offThis feature is not on for your organisation yet.
404not_foundNot found.
429rate_limitedWait 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"
{
  "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
  }
}
Try it
Held in this tab's memory only. Never stored or sent to us.

Use a token with only the read scope. How to make one

Was this helpful?
Open in ClaudeOpen in ChatGPT