The Akeyless Dev Hub

If you're looking for help with the only zero-trust, SaaS, unified platform for secrets management - you've come to the right place.

This is our documentation and updates center.

Documentation

POST / auth

Authenticates to the service and returns a token to be used as a profile to execute the CLI without the need for re-authentication (auth).
This API call consumes the following media types via the Content-Type request header:
application/json

Query Parameters

Detail

access-id (required)

Access ID

access-type (optional)

Access Type (api_key/okta_saml/ldap)

access-key (optional)

Access key (relevant only for access-type=api_key)

ldap_proxy_url (optional)

Address URL for LDAP proxy (relevant only for access-type=ldap)

📘

Authentication methods

In addition to authentication with Access-ID and Access-Key, you can authenticate to Akeyless Vault with username and password.

POST / create-secret

Creates a new secret item (createSecret).
This API call consumes the following media types via the Content-Type request header:
application/json

Query parameters

Details

name (required)

Secret name

value (required)

The secret value

metadata (optional)

Metadata about the secret

key (optional)

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

multiline (optional)

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

token (required)

Access token

POST / get-secret-value

Get static secret value (getSecretValue)
This API call consumes the following media types via the Content-Type request header:
application/json

Query Parameter

Details

name (required)

Secret name

token (required)

Access token

The full list of API calls can be found in the link below, download it and push it to https://editor.swagger.io/

Updated 2 months ago

REST API


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.