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.
applyingappliedfailedtotalintegerRequired
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
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | scope_required | Use a token with the scope named in scope. |
404 | feature_off | This feature is not on for your organisation yet. |
404 | not_found | Not found. |
422 | ssh_environment_unmanaged | SSH on this environment is not managed by the Control Panel. Contact support. |
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/ssh/changes/48211 \
-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/ssh/changes/48211');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/ssh/changes/48211', {
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/ssh/changes/48211",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"applied": 1,
"failed": [],
"id": 48211,
"not_on_new_system": 0,
"state": "applying",
"total": 3,
"waiting": 1
}{
"message": "Unauthenticated."
}{
"code": "scope_required",
"message": "This access token does not have the destructive scope this needs. Use a token with the destructive scope.",
"reason": "scope_required",
"scope": "destructive"
}{
"code": "feature_off",
"message": "Not found.",
"reason": "feature_off"
}{
"code": "ssh_environment_unmanaged",
"field": null,
"message": "SSH removal requires staff verification of an earlier delivery.",
"reason": "ssh_environment_unmanaged"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}Try it
Was this helpful?