---
title: "corestack_ssh_change_get"
url: https://docs.corefinity.com/mcp/tools/corestack_ssh_change_get
type: tool
last_updated: 2026-11-13
feature: ssh-keys
related:
  - https://docs.corefinity.com/api/reference/access/get-ssh-change.md
  - https://docs.corefinity.com/guides/sites/access-and-security/ssh-keys.md
---
# corestack_ssh_change_get

**Show an SSH key change.** Shows how far an SSH key change has got: the environments it reaches that have applied it, wait for their switch-over or failed (and why). Scope: read.

- Scope: `read`
- Runs as a task: no

## When to use it

Follow an SSH key change: how many of the environments it reaches have applied it, how many wait for their switch-over, and which failed and why. The status tool of the `ssh_change` tasks.

The answer is `state` (`applying`, `applied` or `failed`), `applied` of `total`, `waiting` (environments that take the change at their switch-over or platform update), `not_on_new_system` and `failed[]` (environment ids and reasons). `total` counts only the environments on the new system or joining it: an environment that is not on the new system yet, and has not applied the change, is counted in `not_on_new_system` and never as applying, waiting or failed (one that applied it before it left counts as applied). So a change whose other environments have all applied it is `applied`, and one whose environments are all outside is `applied` with `total` 0. Its task completes then too. A note says when `not_on_new_system` is above 0; do not say the change failed or is waiting for those environments.

A managed CoreStack Enterprise target whose environment has been deleted remains
unconfirmed until its SSH target cleanup is verified. Its removal reports `failed`
with “SSH removal requires staff verification.” Deleting a panel row never proves
revocation. Staff reconcile the pinned target; a reused or unreadable target keeps
an owned critical residual. The same rule applies to the Control Panel and REST
`GET /api/ssh/changes/{change}`. No credentials or key material appear in the reason. Older deliveries can lack
complete grant attribution after an agency link changes. Such a removal remains
recorded and unconfirmed; polling refuses `ssh_environment_unmanaged` with “SSH
removal requires staff verification of an earlier delivery.” No other tenant's
ids or counts are returned. Staff verification of the retired target resolves it.

## Inputs

- `change_id` (integer, required)

### Input schema

```json
{
  "additionalProperties": false,
  "properties": {
    "change_id": {
      "minimum": 1,
      "type": "integer"
    }
  },
  "required": [
    "change_id"
  ],
  "type": "object"
}
```

## Refusals

- The refusals every tool can answer: `invalid_arguments`, `tenant_mismatch`, `scope_required`, `pin_refused`, `rate_limited`, `temporarily_unavailable`, `internal_error` (corestack://guides/how-this-server-works).
- `switched_off`: SSH keys are not switched on for this object yet.

## Example

```json
{
  "name": "corestack_ssh_change_get",
  "arguments": {
    "change_id": 991201
  }
}
```

## Prompt

```text
Using the Corefinity MCP server, call corestack_ssh_change_get with change_id 991201. (Show an SSH key change.) Tell me what it returned.
```

## The same task elsewhere

- Endpoint: [GET /api/ssh/changes/{change}](https://docs.corefinity.com/api/reference/access/get-ssh-change.md)
- Guide: [SSH keys](https://docs.corefinity.com/guides/sites/access-and-security/ssh-keys.md)
