Skip to main content
PUT
Rotate a credential's secret in place

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization
string | null
x-ankra-organisation-id
string | null

Path Parameters

credential_id
string<uuid4>
required

Body

application/json
payload
Payload · object
required

The fresh secret fields for the credential's provider, for example api_token for Hetzner, UpCloud and DigitalOcean, token_secret for Proxmox VE, access_token for HPE Morpheus, secret_key for Scaleway, application_key/application_secret/consumer_key for OVHcloud, client_secret for Azure, and access_key_id with secret_access_key for a Hetzner credential's Object Storage keys. Connection settings (api_url, project_id, tls_insecure, ...) cannot be rotated.

Response

The probe ran: rotated says whether the stored secret was replaced

rotated
boolean
required

True when the supplied secret passed the provider probe and replaced the stored one; false when the probe failed and nothing was changed.

result
Result · object
required