API Reference

/rotated-secret-create-azure

post
https://api.akeyless.io/rotated-secret-create-azure
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

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

string

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

string

Id of the azure app that hold the serect to be rotated (relevant only for rotator-type=api-key & authentication-credentials=use-target-creds)

boolean

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.

string
Defaults to use-user-creds

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

string
string

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

string

Description of the object

boolean

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.

boolean

Turns on AI Quorum checks for this item.

string
Defaults to false

If set, explicitly provide the storage account details [true/false]

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]

int32

The Hour of the grace rotation in UTC

string

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

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

boolean
Defaults to false

Set output format to JSON

string
string

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

string

Lock this secret after each successful value read

string

Lock TTL in minutes

string

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

string
required

Rotated secret name

output-rule
array of strings

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

output-rule
string

The password for the user principal name to rotate (relevant only for rotator-type=password)

string

The length of the password to be generated

string

The resource group name (only relevant when explicitly-set-sa=true)

string

The name of the storage account (only relevant when explicitly-set-sa=true)

string

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

string

Rotate this secret after it is unlocked

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
string
string
required

The rotator type. options: [target/password/api-key/azure-storage-account]

boolean

Enable this flag to prevent simultaneous use of the same secret

string

Enable/Disable secure remote access [true/false]

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)

boolean

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

string

The name of the storage account key to rotate [key1/key2/kerb1/kerb2] (relevat to azure-storage-account)

tags
array of strings

Add tags attached to this object

tags
string
required

The target name to associate

string

Authentication token (see /auth and /configure)

string

The universal identity token, Required only for universal_identity authentication

string

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

string

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

string

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

string
string

The user principal name to rotate his password (relevant only for rotator-type=password)

Responses

Updated 16 days ago

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

Updated 16 days ago

Did this page help you?
Footer Section