Skip to main content
POST
/
vault_secrets
Create
curl --request POST \
  --url https://api.ngrok.com/vault_secrets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'ngrok-version: <ngrok-version>' \
  --data '{
  "name": "<string>",
  "value": "<string>",
  "metadata": "<string>",
  "description": "<string>",
  "vault_id": "<string>"
}'
{
  "id": "<string>",
  "uri": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "name": "<string>",
  "description": "<string>",
  "metadata": "<string>",
  "created_by": {
    "id": "<string>",
    "uri": "<string>"
  },
  "last_updated_by": {
    "id": "<string>",
    "uri": "<string>"
  },
  "vault": {
    "id": "<string>",
    "uri": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

ngrok-version
integer
default:2
required

Body

application/json
vault_id
string
required

unique identifier of the referenced vault

name
string

Name of secret

value
string

Value of secret

metadata
string

Arbitrary user-defined metadata for this Secret

description
string

description of Secret

Response

201 - application/json

Create a new Secret

id
string

identifier for Secret

uri
string

URI of this Secret API resource

created_at
string

Timestamp when the Secret was created (RFC 3339 format)

updated_at
string

Timestamp when the Secret was last updated (RFC 3339 format)

name
string

Name of secret

description
string

description of Secret

metadata
string

Arbitrary user-defined metadata for this Secret

created_by
object

Reference to who created this Secret

last_updated_by
object

Reference to who created this Secret

vault
object

Reference to the vault the secret is stored in