Skip to main content
PATCH
/
vaults
/
{id}
Update
curl --request PATCH \
  --url https://api.ngrok.com/vaults/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'ngrok-version: <ngrok-version>' \
  --data '
{
  "id": "<string>",
  "name": "<string>",
  "metadata": "<string>",
  "description": "<string>"
}
'
{
  "id": "<string>",
  "uri": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "name": "<string>",
  "description": "<string>",
  "metadata": "<string>",
  "created_by": "<string>",
  "last_updated_by": "<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

Path Parameters

​
id
string
required

identifier for Vault

Body

application/json
​
id
string

identifier for Vault

​
name
string

Name of vault

​
metadata
string

Arbitrary user-defined metadata for this Vault

​
description
string

description of Vault

Response

200 - application/json

Update an existing Vault by ID

​
id
string

identifier for Vault

​
uri
string

URI of this Vault API resource

​
created_at
string

Timestamp when the Vault was created (RFC 3339 format)

​
updated_at
string

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

​
name
string

Name of vault

​
description
string

description of Vault

​
metadata
string

Arbitrary user-defined metadata for this Vault

​
created_by
string

Reference to who created this Vault

​
last_updated_by
string

Reference to who created this Vault