Skip to content

credentials.ssh.delete

DELETE
/credentials/ssh/{credentialId}
curl --request DELETE \
--url https://example.com/api/credentials/ssh/example \
--header 'Content-Type: application/json' \
--data '{ "confirmation": { "credentialId": "example" }, "idempotencyKey": "example" }'

Deletes one reusable SSH credential only when no visible active or inactive server uses it. Public docs: /docs/servers/credentials/ssh-keys/#server-ssh-credential-path

credentialId
required
string
>= 1 characters
Media type application/json
object
confirmation
required
object
credentialId
required
string
>= 1 characters
idempotencyKey
string
>= 1 characters
Example generated
{
"confirmation": {
"credentialId": "example"
},
"idempotencyKey": "example"
}

OK

Media type application/json
object
id
required
string
Example generated
{
"id": "example"
}