API Reference

/rotated-secret-update-custom

post
https://api.akeyless.io/rotated-secret-update-custom
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
add-tag
array of strings

List of the new tags that will be attached to this item

add-tag
string
Defaults to use-user-creds

The credentials to connect with use-user-creds/use-target-creds

string

Whether to automatically rotate every --rotation-interval days, or disable existing automatic rotation [true/false]

string

Secret payload to be sent with rotation request

string

Protection from accidental deletion of this object [true/false]

string
Defaults to default_metadata

Description of the object

string

Enable password policy

item-custom-fields
object

Additional custom fields to associate with the item

boolean
Defaults to false

Set output format to JSON

string

Whether to keep previous version [true/false]. If not set, use default according to account settings

string

The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)

string

Lock this secret for read/update while an SRA session is active

string

Set the maximum number of versions, limited by the account settings defaults.

string
required

Rotated secret name

string

New item name

string

The length of the password to be generated

rm-tag
array of strings

List of the existent tags that will be removed from this item

rm-tag
string

StringOrBool accepts JSON strings, booleans, and numbers for backward compatibility with older SDK versions that send boolean values for rotate-after-disconnect.

rotation-event-in
array of strings

How many days before the rotation of the item would you like to be notified

rotation-event-in
int32

The Hour of the rotation in UTC

string

The number of days to wait between every automatic key rotation (1-365)

boolean
Defaults to false

Allow providing external user for a domain users

string

Deprecated. use secure-access-certificate-issuer

string

Path to the SSH Certificate Issuer for your Akeyless Secure Access

string

Enable/Disable secure remote access [true/false]

secure-access-host
array of strings

Target servers for connections (In case of Linked Target association, host(s) will inherit Linked Target hosts - Relevant only for Dynamic Secrets/producers)

secure-access-host
string

Default domain name server. i.e. microsoft.com

string

Override the RDP Domain username

string

Override the SSH username as indicated in SSH Certificate Issuer

string

Destination URL to inject secrets

boolean
Defaults to false

Enable Web Secure Remote Access

boolean
Defaults to false

Secure browser via Akeyless's Secure Remote Access (SRA)

boolean
Defaults to false

Web-Proxy via Akeyless's Secure Remote Access (SRA)

int64

Maximum allowed time in seconds for the custom rotator to return the results

string

Authentication token (see /auth and /configure)

string

The universal identity token, Required only for universal_identity authentication

string

Password must contain capital letters [true/false]

string

Password must contain lower case letters [true/false]

string

Password must contain numbers [true/false]

string

Password must contain special characters [true/false]

Responses

Updated 7 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago

Footer Section