/rotated-secret-update-aws

post

https://api.akeyless.io/rotated-secret-update-aws

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

add-tag

array of strings

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

add-tag

api-id

string

API ID to rotate (relevant only for rotator-type=api-key)

api-key

string

API key to rotate (relevant only for rotator-type=api-key)

authentication-credentials

string

Defaults to use-user-creds

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

auto-rotate

string

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

aws-region

string

Defaults to us-east-2

Aws Region

delete_protection

string

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

description

string

Defaults to default_metadata

Description of the object

grace-rotation

string

Enable graceful rotation (keep both versions temporarily). When enabled, a new secret version is created while the previous version is kept for the grace period, so both versions exist for a limited time. [true/false]

grace-rotation-hour

int32

The Hour of the grace rotation in UTC

grace-rotation-interval

string

The number of days to wait before deleting the old key (must be bigger than rotation-interval)

grace-rotation-timing

string

When to create the new version relative to the rotation date [after/before]

input-rule

array of strings

Agentic input rule in name=...,rule=... format (e.g. name=rule1,rule=Sanitize input)

input-rule

item-custom-fields

object

Additional custom fields to associate with the item

json

boolean

Defaults to false

Set output format to JSON

keep-prev-version

string

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

key

string

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

lock-during-sra-session

string

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

max-versions

string

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

name

string

required

Rotated secret name

new-name

string

New item name

output-rule

array of strings

Agentic output rule in name=...,rule=... format (e.g. name=rule1,rule=Mask secrets)

output-rule

password-length

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

rotate-after-disconnect

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

rotation-hour

int32

The Hour of the rotation in UTC

rotation-interval

string

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

secure-access-aws-account-id

string

The AWS account id

secure-access-aws-native-cli

boolean

The AWS native cli

secure-access-bastion-issuer

string

Deprecated. use secure-access-certificate-issuer

secure-access-certificate-issuer

string

Path to the SSH Certificate Issuer for your Akeyless Secure Access

secure-access-enable

string

Enable/Disable secure remote access [true/false]

token

string

Authentication token (see /auth and /configure)

uid-token

string

The universal identity token, Required only for universal_identity authentication

Responses

201rotatedSecretUpdateAwsResponse wraps response body.

defaulterrorResponse wraps any error to return it as a JSON object with one "error" field.