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

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.

GET/api/user/ssh

Returns

200 Your keys and username.

Fields of the 200 answer
can_addobjectRequired

Whether you may add a key here.

Fields
allowedbooleanRequired
refusedstring or nullRequired

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_elsewherenull
can_have_loginbooleanRequired
keysarray of objectsRequired
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.

loginobject or any or nullRequired

Your username. Null while none can be issued; reason says why.

reacharray of objectsRequired

The environments your username reaches.

Fields of each item
commandstring or nullRequired

The ssh command to connect.

environmentobjectRequired

An environment, with the website and company it belongs to.

Fields
companyobjectRequired
Fields
idintegerRequired

At least 1.

namestringRequired
idintegerRequired

The environment id, the {environment} these endpoints take and the owner.id of an environment key.

namestringRequired
productstringRequired

cse is CoreStack Enterprise.

csecorestackcorecluster
site_idinteger or nullRequired

The site row id the /corestack/sites/{site} endpoints take. Null on CoreStack Enterprise.

websiteobjectRequired
Fields
idintegerRequired

At least 1.

namestringRequired
hoststring or nullRequired
portinteger or nullRequired
statestringRequired
readywaiting_for_switch_overwaiting_for_platform_updatenot_switched_onfailedunmanaged
reasonstring or nullRequired

Why login is null. handle_missing means your company has no SSH handle yet, or your account belongs to no company.

handle_missingnull
ssh_configstring or nullRequired

A ~/.ssh/config block for every environment that is ready. Null when none is.

user_idintegerRequired

Your user id, the owner.id of a personal key.

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403scope_requiredUse a token with the scope named in scope.
404feature_offThis feature is not on for your organisation yet.
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/user/ssh \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "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
}
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