Get a site's SSH and SFTP access
Answers how to connect to the site or environment, its users with their keys, the company keys that reach it, and ready ssh, sftp, rsync and database tunnel commands for the built-in web user. While SSH keys are on for your company it also answers the usernames and host keys, and web lists every key that can log in as it.
Path parameters
The id of a site row. A website's production site and each of its environments has its own id. Digits only. At least 1.
Returns
200 The site's access.
Fields of the 200 answer
Whether the saved users and keys are live on the site. Whether a saved set of rules is live on the site.
Fields
Sent only by the sets that have more to say, such as HTTP authentication.
The change that is applying the set, while one is running.
Such as applied or applying.
The company keys that can reach the site.
Fields of each item
Whether the key reaches this site.
Whether the company key applies to all of the company's sites or to selected ones.
allselectedAt least 1.
Where to connect.
Fields
The SSH host of the site's cluster. Empty while the site has none yet.
The site's or environment's own port.
The built-in user, web.
An ssh command that opens a tunnel to the database on 127.0.0.1:3306 of your machine.
Fields
Folders an SFTP user is often limited to on this kind of site.
The most named users a site can have.
Whether the browser terminal can be opened for the site.
Fields
The open terminal session on the site, when there is one, whoever opened it.
Fields
At least 1.
When the session started, in UTC with a +00:00 offset. Format: date-time.
Who opened the session. A session Corefinity support opened reads Corefinity support with a null id. A person by id and name. Corefinity staff read as Corefinity support with a null id.
Fields
Why not, in plain words.
The built-in web user first, then the named users.
Fields of each item
Fields
The ssh command. Null for an SFTP user.
The id the /access/users/{user} endpoints take.
The user's keys. While SSH keys are on for your company, web lists every key that can log in as it, from every level.
Fields of each item
Whether this endpoint group can remove the key. Other keys are removed where they were added.
The comment at the end of the key line, when it had one.
The SHA-256 fingerprint, as ssh-keygen -lf prints it.
The id DELETE / takes. 0 for the Corefinity deploy key.
Sent while SSH keys are on for your company. The level the key comes from.
Fields
agencycompanywebsiteenvironmentuserlegacysystemTrue when the key carries restrictions from before it was imported. Only Corefinity changes those.
company is a company key. system is the Corefinity deploy key. Everything else reads user.
usercompanysystempendingappliedfailedremovingThe key type, such as ssh-ed25519 or ssh-rsa.
built_in is web. It cannot be changed or removed.
built_innamedWhether the user has a password. The password itself is never answered here.
Fields
The folder an SFTP user is limited to, relative to the site.
The same folder as a path on the server.
pending until the change that made or changed the user is live.
pendingappliedfailedremovingsshsftpThe user's numeric id on the server.
The host keys the site presents.
Fields
Fields of each item
ed25519ecdsarsaThe host keys a staged rotation will switch to.
Fields of each item
ed25519ecdsarsaComplete known_hosts lines for the site's host keys. Empty when none are recorded.
The usernames you can connect with.
Fields
Fields
Your own username on this environment.
The personal usernames that reach the site, with their keys. Read-only here.
Fields of each item
Fields of each item
Whether this endpoint group can remove the key. Other keys are removed where they were added.
The comment at the end of the key line, when it had one.
The SHA-256 fingerprint, as ssh-keygen -lf prints it.
The id DELETE / takes. 0 for the Corefinity deploy key.
Sent while SSH keys are on for your company. The level the key comes from.
Fields
agencycompanywebsiteenvironmentuserlegacysystemTrue when the key carries restrictions from before it was imported. Only Corefinity changes those.
company is a company key. system is the Corefinity deploy key. Everything else reads user.
usercompanysystempendingappliedfailedremovingThe key type, such as ssh-ed25519 or ssh-rsa.
Ready commands for the built-in web user. An empty list while the site has no SSH host or port yet.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | company_unavailable | Your company is unavailable. |
403 | scope_required | Use a token with the scope named in scope. |
403 | two_factor_required | Turn on two-factor on your account, then send again. |
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/corestack/sites/1042/access \
-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/corestack/sites/1042/access');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/corestack/sites/1042/access', {
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/corestack/sites/1042/access",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"apply": {
"applied_at": "2026-11-03T10:03:10+00:00",
"error": null,
"operation": null,
"state": "applied",
"state_label": "Applied"
},
"company_keys": [],
"connection": {
"host": "ssh-northwind.example.net",
"port": 20101,
"ssh_user": "web",
"tunnel_command": "ssh -N -L 3306:127.0.0.1:3306 -p 20101 [email protected]"
},
"host_keys": {
"current": [
{
"fingerprint": "SHA256:ExampleHostKeyEd25519FingerprintNotARealOne",
"type": "ed25519"
}
],
"managed_by": "panel",
"next": null
},
"known_hosts": [
"[ssh-northwind.example.net]:20101 ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIAAAExampleHostKeyOnlyThisIsNotARealHostKey1"
],
"limits": {
"company_keys_max": 50,
"keys_per_user_max": 50,
"root_path_suggestions": [
"htdocs",
"htdocs/wp-content/uploads",
"shared"
],
"users_max": 25
},
"logins": {
"web": {
"command": "ssh -p 20101 [email protected]",
"login": "web"
},
"you": {
"command": "ssh -p 20101 [email protected]",
"delivered": true,
"login": "maya-northwind",
"state": "ready"
}
},
"persons": [],
"ready_lines": {
"rsync": "rsync -e 'ssh -p 20101' -a ./ [email protected]:/var/www/harbourandfinch.example.com/htdocs/",
"sftp": "sftp -P 20101 [email protected]",
"ssh": "ssh -p 20101 [email protected]",
"tunnel": "ssh -N -L 3306:127.0.0.1:3306 -p 20101 [email protected]"
},
"terminal": {
"active_session": null,
"available": true,
"reason": null
},
"users": [
{
"can_change": false,
"can_delete": false,
"connection": {
"command": "ssh -p 20101 [email protected]",
"sftp_command": "sftp -P 20101 [email protected]"
},
"created_at": "2026-11-02T10:15:00+00:00",
"created_by": null,
"id": 417,
"keys": [
{
"added_at": "2026-11-03T10:02:44+00:00",
"added_by": {
"id": 2011,
"name": "Maya Okafor"
},
"bits": null,
"can_delete": true,
"comment": null,
"company_key_id": null,
"fingerprint": "SHA256:O2Hqs6Iw0tDmPEeRkLTcr6n4V7Vhu5oPJRWviv9+2Ro",
"id": 7308,
"name": "Deployment service",
"origin": {
"layer": "environment",
"owner": {
"id": 1342,
"name": "Production",
"type": "environment"
}
},
"restricted": false,
"restrictions": [],
"source": "user",
"status": "applied",
"status_label": "Applied",
"type": "ssh-ed25519"
},
{
"added_at": "2026-11-02T10:15:00+00:00",
"added_by": null,
"bits": null,
"can_delete": false,
"comment": null,
"company_key_id": null,
"fingerprint": "SHA256:ExampleDeployKeyFingerprintNotARealOne00000",
"id": 0,
"name": "Corefinity deploy key",
"origin": {
"layer": "system",
"owner": null
},
"restricted": false,
"restrictions": [],
"source": "system",
"status": "applied",
"status_label": "Applied",
"type": "ssh-rsa"
}
],
"kind": "built_in",
"label": null,
"password": {
"set": false,
"set_at": null,
"set_by": null
},
"root_path": null,
"root_path_absolute": null,
"status": "applied",
"status_label": "Applied",
"type": "ssh",
"type_label": "SSH + SFTP",
"uid": 9991,
"username": "web"
},
{
"can_change": true,
"can_delete": true,
"connection": {
"command": "ssh -p 20101 [email protected]",
"sftp_command": "sftp -P 20101 [email protected]"
},
"created_at": "2026-11-02T10:15:00+00:00",
"created_by": {
"id": 2011,
"name": "Maya Okafor"
},
"id": 3418,
"keys": [
{
"added_at": "2026-11-03T10:02:44+00:00",
"added_by": null,
"bits": null,
"can_delete": true,
"comment": null,
"company_key_id": null,
"fingerprint": "SHA256:KhDfvkk2rdhCA9zaR3SurL80w/B/MbslK5FOxIaEpY0",
"id": 7312,
"name": "Supplier laptop",
"restricted": false,
"restrictions": [],
"source": "user",
"status": "applied",
"status_label": "Applied",
"type": "ssh-ed25519"
}
],
"kind": "named",
"label": "Print supplier",
"password": {
"set": false,
"set_at": null,
"set_by": null
},
"root_path": null,
"root_path_absolute": null,
"status": "applied",
"status_label": "Applied",
"type": "ssh",
"type_label": "SSH + SFTP",
"uid": 20001,
"username": "supplier"
}
]
}{
"message": "Unauthenticated."
}{
"code": "company_unavailable",
"message": "Your company is unavailable.",
"reason": "company_unavailable"
}{
"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
}