CommunityWebsiteDocumentationExchangeSupportDeveloper
HomeGuidesAPI Reference
CommunityWebsiteDocumentationExchangeSupportDeveloper
API Reference

Write a Cypher

post
https://{serverURL}/api/cypher/

This endpoint will create or update a cypher key.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The key includes a mount prefix separated by a /. For example, the key secret/foo uses the secret mount.

Available Mounts

Mount Description Example
password Generates a secure password of specified character length in the key pattern (or 15) with symbols, numbers, upper case, and lower case letters (i.e. password/15/mypass generates a 15 character password). password/15/mypass
tfvars This is a module to store a tfvars file for terraform. tfvars/mytfvar
secret This is the standard secret module that stores a key/value in encrypted form. Capable of storing entire JSON object or a String. secret/foo
uuid Returns a new UUID by key name when requested and stores the generated UUID by key name for a given lease timeout period. uuid/autoMac1
key Generates a Base 64 encoded AES Key of specified bit length in the key pattern (i.e. key/128/mykey generates a 128-bit key) key/128/mykey
Query Params

Time to Live. The lease duration in seconds, or a human readable format eg. '15m', 8h, '7d'. 0 means no expiry.

string

The secret value to be stored. Only required for certain mounts. Some mounts generate their own value and do not require a value to be passed. eg. uuid, key and password.

string

The type of data being stored, string or object. The data type depends on the cypher mount being used. Most mounts use string as their data type, but secret uses object by default. You can store a string instead by passing type=string. This means the data value returned by the API will be a string instead of an object.

Body Params

Time to Live. The lease duration in seconds, or a human readable format eg. 15m, 8h, 7d. The default is 0 meaning Never expires. This only is applied if the cypher does not yet exist and is created.

string

The secret value to be stored. This is only parsed if type is passed as string.

Responses

Updated over 2 years ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 2 years ago