Skip to main content
PATCH
Update

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

Path Parameters

id
string
required

identifier for Secret

Body

application/json
id
string

identifier for Secret

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

Update an existing Secret by ID

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

vault_name
string

Name of the vault the secret is stored in