AKakeyless
Rotated Secrets

POST /rotated-secret-create-alicloud

Changed on

Request

  • Base URL
    https://api.akeyless.io
  • URL
    https://api.akeyless.io/rotated-secret-create-alicloud
  • Auth
    none declared

Request body

access-keystring

AliCloud RAM user AccessKey secret to rotate (relevant only for rotator-type=access-key)

access-key-idstring

AliCloud RAM user AccessKey ID to rotate (relevant only for rotator-type=access-key). On create with authentication-credentials=use-target-creds it may be empty, then Akeyless creates the AccessKey on the RAM user of the target and manages it

ara-enabledboolean

Enable or disable Agentic Runtime Authority rule enforcement for this item. When false, user-defined input/output rules are stored but not enforced; the base security validation still runs.

AraEnabled is tri-state (nil/true/false), not a plain bool: it self-encodes its wire value (see akl.OptionalBool) so an explicit false survives the curl-proxy relay instead of being dropped like a default-false bool flag.

authentication-credentialsstring

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

auto-rotatestring
delete_protectionstring

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

descriptionstring

Description of the object

enable-agentic-runtime-authorityboolean

EnableAra is the documented spelling of AraEnabled. Both set the same field; --ara-enabled shipped first and stays as an undocumented alias so existing scripts and the Terraform provider keep working.

enable-ai-quorumboolean

Turns on AI Quorum checks for this item.

grace-rotationstring

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-hourinteger

The Hour of the grace rotation in UTC

grace-rotation-intervalstring

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

grace-rotation-timingstring

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

input-rulestring[]

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

item-custom-fieldsobject

Additional custom fields to associate with the item

jsonboolean

Set output format to JSON

keystring
lock-on-readstring

Lock this secret after each successful value read

lock-ttlstring

Lock TTL in minutes

max-versionsstring

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

namestring required

Rotated secret name

output-rulestring[]

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

password-lengthstring

The length of the password to be generated

rotate-on-unlockstring

Rotate this secret after it is unlocked

rotation-event-instring[]

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

rotation-hourinteger
rotation-intervalstring
rotator-typestring required

The rotator type. options: [target/access-key]

skip-dry-runboolean

If set, dry-run will be skipped [true/false]

tagsstring[]

Add tags attached to this object

target-namestring required

The target name to associate

tokenstring

Authentication token (see /auth and /configure)

uid-tokenstring

The universal identity token, Required only for universal_identity authentication

use-capital-lettersstring

Specifies whether the generated temporary password must contain at least one uppercase character from the ISO basic Latin alphabet (A to Z). [true/false]

use-lower-lettersstring

Specifies whether the generated temporary password must contain at least one lowercase character from the ISO basic Latin alphabet (a to z). [true/false]

use-numbersstring

Specifies whether the generated temporary password must contain at least one numeric character (0 to 9). [true/false]

use-special-charactersstring

Example request

{
  "use-special-characters": "! @ # $. [true/false]"
}

Response

rotatedSecretCreateAliCloudResponse wraps response body.

namestring

Changes