/create-secret

post

https://api.akeyless.io/create-secret

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

ProviderType

string

accessibility

string

Defaults to regular

for personal password manager

ara-enabled

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.

change-event

string

Trigger an event when a secret value changed [true/false] (Relevant only for Static Secret)

custom-field

object

For Password Management use, additional fields

delete_protection

string

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

description

string

Description of the object

enable-agentic-runtime-authority

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.

enable-ai-quorum

boolean

Turns on AI Quorum checks for this item.

format

string

Defaults to text

Secret format [text/json/key-value] (relevant only for type 'generic')

host-provider

string

Host provider type [explicit/target], Default Host provider is explicit, Relevant only for SRA items.

inject-url

array of strings

For Password Management use, reflect the website context

inject-url

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

lock-during-sra-session

string

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

lock-on-read

string

Lock this secret after each successful value read

lock-ttl

string

Lock TTL in minutes

max-versions

string

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

metadata

string

Deprecated - use description

multiline_value

boolean

The provided value is a multiline value (separated by '\n')

name

string

required

Secret name

output-rule

array of strings

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

output-rule

password

string

For Password Management use, additional fields

protection_key

string

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

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]

secure-access-enforce-hosts-restriction

boolean

Enforce connections only to allowed SRA hosts

secure-access-gateway

string

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

secure-access-rdp-user

string

Remote Desktop Username

secure-access-ssh-creds

string

Static-Secret values contains SSH Credentials, either Private Key or Password [password/private-key]

secure-access-ssh-user

string

Override the SSH username as indicated in SSH Certificate Issuer

secure-access-url

string

Destination URL to inject secrets

secure-access-web-browsing

boolean

Defaults to false

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

secure-access-web-proxy

boolean

Defaults to false

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

200createSecretResponse wraps response body.

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