Remove or deduplicate an SSH key on a specific host

post

https://{sandfly-api-host}/v4/responseaction/sshpubkey/{keyid}/{action}/host/{host_sequence_id}

Performs an SSH key response action on a specific host for all users that have the key. Requires the responder role. For 'remove' actions, a last-key protection safety check denies the request with HTTP 409 if the host would be left with zero SSH keys known to Sandfly; set allow_last_key_removal=true in the request body to override.

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

202Action queued for the specified host.

400Key has no stored value, host is inactive, or no placements found.

403Insufficient role or response actions disabled.

404Key or host not found, or no active placements.

409Last-key protection: the remove action would leave the host with no SSH keys known to Sandfly. The response body identifies the affected host and users. Set allow_last_key_removal=true in the request body to override.

defaultUnexpected error