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

Get a website's SSH keys

Answers the keys held at the website, the keys it inherits from its company and agency, and its environments with the state of each one's keys.

GET/api/websites/{website}/ssh

Path parameters

websiteintegerRequired

The id of a CoreStack Enterprise website. Not the same number as a site row id. At least 1.

Returns

200 The website's keys.

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
environmentsarray of objectsRequired
Fields of each item
delivery_statestringRequired
pendingapplyingappliedfaileddriftwaitingunmanaged
idintegerRequired
namestringRequired
site_idinteger or nullRequired
grantsarray of objectsRequired

The website'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

Keys from the company and agency levels that reach the website.

Fields of each item
added_atstring or nullRequired

Format: date-time.

added_byobject or any or nullRequired
bitsinteger or nullRequired

The key size, for RSA keys.

deliveryobjectRequired

Whether the key works on this environment yet.

Fields
planned_forstring or nullRequired

When a waiting environment is planned to switch over. Format: date-time.

statestringRequired

waiting means the environment has not switched to keys managed by the Control Panel yet.

appliedapplyingremovingfailedwaiting
editablebooleanRequired

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

fingerprintstringRequired

The SHA-256 fingerprint, as ssh-keygen -lf prints it.

idinteger or nullRequired

The key id the /ssh/keys/{key} endpoints take. Null for the Corefinity deploy key.

last_used_atstring or nullRequired

Format: date-time.

legacyobject or any or nullRequired

Set for a Legacy key, else null.

namestringRequired
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.

sourceobjectRequired

The level a key on an environment comes from.

Fields
layerstringRequired

agency is a key of your agency. system is the Corefinity deploy key.

agencycompanywebsiteenvironmentuserlegacysystem
ownerobject or any or nullRequired

Null for a key that has no owner you can see.

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.

websiteobjectRequired
Fields
companyobjectRequired
Fields
idintegerRequired

At least 1.

namestringRequired
idintegerRequired
namestringRequired
productstringRequired
csecorestackcorecluster

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.
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/websites/1310/ssh \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "can_add": {
    "allowed": true,
    "refused": null
  },
  "environments": [
    {
      "delivery_state": "applied",
      "id": 1311,
      "name": "Production",
      "site_id": 1042
    }
  ],
  "grants": [],
  "inherited": [
    {
      "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": null,
      "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
    }
  ],
  "website": {
    "company": {
      "id": 1204,
      "name": "Harbour & Finch"
    },
    "id": 1310,
    "name": "Harbour & Finch trade",
    "product": "corecluster"
  }
}
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