Sign in

v1

latestOpenAPI 3.0.02026-07-246171,3332.1 MB
v2

post/create-secret

Request body

accessibilitystring

for personal password manager

change-eventstring

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

custom-fieldobject

For Password Management use, additional fields

delete_protectionstring

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

descriptionstring

Description of the object

formatstring

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

inject-urlstring[]

For Password Management use, reflect the website context

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

lock-during-sra-sessionstring

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

max-versionsstring

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

metadatastring

Deprecated - use description

multiline_valueboolean

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

namestring required

Secret name

output-rulestring[]

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

passwordstring

For Password Management use, additional fields

protection_keystring

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

Deprecated. use secure-access-certificate-issuer

secure-access-certificate-issuerstring

Path to the SSH Certificate Issuer for your Akeyless Secure Access

secure-access-enablestring

Enable/Disable secure remote access [true/false]

secure-access-gatewaystring
secure-access-hoststring[]

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-rdp-userstring

Remote Desktop Username

secure-access-ssh-credsstring

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

secure-access-ssh-userstring

Override the SSH username as indicated in SSH Certificate Issuer

secure-access-urlstring

Destination URL to inject secrets

secure-access-web-browsingboolean

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

secure-access-web-proxyboolean

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

tagsstring[]

Add tags attached to this object

tokenstring

Authentication token (see /auth and /configure)

typestring

The secret sub type [generic/password]

uid-tokenstring

The universal identity token, Required only for universal_identity authentication

usernamestring

For Password Management use

valuestring required

The secret value (relevant only for type 'generic')

Response

createSecretResponse wraps response body.

namestring