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

Get an SSH change

Answers how far a change to keys has been applied. Read it again until state is applied or failed. You can read a change you started, or one that goes to an environment you can reach.

GET/api/ssh/changes/{change}

Path parameters

changeintegerRequired

The id of a change, as a key request answers it in change_id. Digits only. A host-key rotation answers change_id 0, which is not a change to read here. At least 1.

Returns

200 The change.

Fields of the 200 answer
appliedintegerRequired

Environments the change is live on.

failedarray of objectsRequired

The environments the change failed on, each with a reason.

Fields of each item
environment_idintegerRequired
reasonstringRequired
idintegerRequired
not_on_new_systemintegerRequired

Environments whose keys the Control Panel does not manage yet. Not counted in total.

statestringRequired

applied and failed are final.

applyingappliedfailed
totalintegerRequired

Environments the change goes to.

waitingintegerRequired

Environments that take the change only when they switch over or get a platform update.

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.
422ssh_environment_unmanagedSSH on this environment is not managed by the Control Panel. Contact support.
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/ssh/changes/48211 \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "applied": 1,
  "failed": [],
  "id": 48211,
  "not_on_new_system": 0,
  "state": "applying",
  "total": 3,
  "waiting": 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