v1
latestOpenAPI 3.0.02026-07-246171,3332.1 MBRequest body
The credentials to connect with use-user-creds/use-target-creds
Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation [true/false]
Protection from accidental deletion of this object [true/false]
Description of the object
Agentic input rule in name=...,rule=... format (e.g. name=rule1,rule=Sanitize input)
Additional custom fields to associate with the item
Set output format to JSON
The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
Private key file contents encoded using base64
Lock this secret for read/update while an SRA session is active
Set the maximum number of versions, limited by the account settings defaults.
Rotated secret name
Agentic output rule in name=...,rule=... format (e.g. name=rule1,rule=Mask secrets)
The length of the password to be generated
The path to the public key that will be rotated on the server
StringOrBool accepts JSON strings, booleans, and numbers for backward compatibility with older SDK versions that send boolean values for rotate-after-disconnect.
rotated-username password (relevant only for rotator-type=password)
username to be rotated, if selected use-self-creds at rotator-creds-type, this username will try to rotate it's own password, if use-target-creds is selected, target credentials will be use to rotate the rotated-password (relevant only for rotator-type=password)
How many days before the rotation of the item would you like to be notified
The Hour of the rotation in UTC
The number of days to wait between every automatic key rotation (1-365)
Custom rotation command
The rotator type. options: [target/password/key]
Rotate same password for each host from the Linked Target (relevant only for Linked Target)
Allow providing external user for a domain users
Deprecated. use secure-access-certificate-issuer
Path to the SSH Certificate Issuer for your Akeyless Secure Access
Enable/Disable secure remote access [true/false]
Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers)
Default domain name server. i.e. microsoft.com
Override the RDP Domain username
Override the SSH username as indicated in SSH Certificate Issuer
Specify target type. Options are ssh or rdp
Add tags attached to this object
The target name to associate
Authentication token (see /auth and /configure)
The universal identity token, Required only for universal_identity authentication
Response
rotatedSecretCreateSshResponse wraps response body.