Static Secrets

POST /create-secret

Changed on

Request

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

Request body

ProviderTypestring
accessibilitystring

for personal password manager

ara-enabledboolean nullable

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

enable-agentic-runtime-authorityboolean nullable

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 nullable

Turns on AI Quorum checks for this item.

formatstring

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

host-providerstring

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

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

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.

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-enforce-hosts-restrictionboolean

Enforce connections only to allowed SRA hosts

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

targetstring[]

A list of targets to be associated with an SRA item, To specify multiple targets use argument multiple times

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

Changes

    • info

      api tag Static Secrets added

    • info

      api tag v2 removed

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property