Skip to content
Appaloft 文档 v0.6.0

credentials.ssh.rotate

POST
/credentials/ssh/{credentialId}/rotate
 
curl --request POST \
  --url https://example.com/api/credentials/ssh/example/rotate \
  --header 'Content-Type: application/json' \
  --data '{ "privateKey": "example", "publicKey": "example", "username": "example", "confirmation": { "credentialId": "example", "acknowledgeServerUsage": true }, "idempotencyKey": "example" }'

Rotates one reusable SSH credential in place after usage visibility and acknowledgement checks. Public docs: /docs/servers/credentials/ssh-keys/#server-ssh-credential-path

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
credentialId
required
string
>= 1 characters

Request Body required

Section titled “Request Body required ”
Media type application/json
object
privateKey
required
string
>= 1 characters
publicKey
Any of:
string
>= 1 characters
username
Any of:
string
>= 1 characters
confirmation
required
object
credentialId
required
string
>= 1 characters
acknowledgeServerUsage
boolean
idempotencyKey
string
>= 1 characters
Example generated
{
  "privateKey": "example",
  "publicKey": "example",
  "username": "example",
  "confirmation": {
    "credentialId": "example",
    "acknowledgeServerUsage": true
  },
  "idempotencyKey": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
schemaVersion
required
string
Allowed value: credentials.rotate-ssh/v1
credential
required
object
id
required
string
kind
required
string
Allowed value: ssh-private-key
usernameConfigured
required
boolean
publicKeyConfigured
required
boolean
privateKeyConfigured
required
boolean
rotatedAt
required
string
affectedUsage
required
object
totalServers
required
number
activeServers
required
number
inactiveServers
required
number
servers
required
Array<object>
object
serverId
required
string
serverName
required
string
lifecycleStatus
required
string
Allowed values: active inactive
providerKey
required
string
host
required
string
username
string
Example 
{
  "schemaVersion": "credentials.rotate-ssh/v1",
  "credential": {
    "kind": "ssh-private-key"
  },
  "affectedUsage": {
    "servers": [
      {
        "lifecycleStatus": "active"
      }
    ]
  }
}