Skip to main content
POST

Authorizations

​
Authorization
string
header
required

Your SLNG consumer API key.

Body

application/json

The name, kind, value, and optional description of the Vault entry to create.

Request body for creating a Vault entry. Supply the name, the kind (secret or variable), the value to store, and an optional description.

​
name
string
required

SCREAMING_SNAKE_CASE, unique per org

​
kind
enum<string>
required

Whether this entry is a secret (write-only; its value is never returned) or a variable (its value is readable by authorized callers).

Available options:
secret,
variable
​
value
string
required
write-only

The secret or variable value to store. Write-only: it is never returned in responses.

Required string length: 1 - 10000
​
description
string | null

Optional human-readable description of this resource.

Maximum string length: 500

Response

The created Vault entry. Secret values are masked in the response.

List and detail view of a Vault entry. Secret values are never returned; variable values are returned to authorized readers in value (null for secrets).

​
id
string<uuid>
required
​
organisation_id
string<uuid>
required
​
name
string
required
​
kind
enum<string>
required

Kind of this entry: secret values are never returned, variable values are readable by authorized callers.

Available options:
secret,
variable
​
revision
integer
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
description
string | null
​
value
string | null

The stored value, returned only for variables to authorized readers. Always null for secrets, whose value is never returned.

​
has_value
boolean
default:true

Whether a value is stored. True even for secrets, whose value is withheld from responses.

​
is_managed
boolean
default:false

Whether this entry is managed by SLNG rather than created directly by your organisation.

​
created_by
string | null
​
last_rotated_by
string | null
​
last_rotated_at
string<date-time> | null