Vaults - ngrok documentation

Create Vault

Create a new Vault

Request

POST /vaults

Example Request

curl \
-X POST \
-H "Authorization: Bearer {API_KEY}" \
-H "Content-Type: application/json" \
-H "Ngrok-Version: 2" \
-d '{"description":"Production Vault","metadata":"env=prod","name":"prod-vault"}' \
https://api.ngrok.com/vaults

Parameters

Name	Type	Description
`name`	string	Name of vault
`metadata`	string	Arbitrary user-defined metadata for this Vault
`description`	string	description of Vault

Response

Returns a 201 response on success

Example Response

{
  "created_at": "2025-09-04T10:11:43Z",
  "created_by": "usr_32ELAUA7XkJHRP2DgH2JjDRLp81",
  "description": "Production Vault",
  "id": "vault_32ELIL9nzEhwlvjSpNSI6xXGNcE",
  "last_updated_by": "usr_32ELAUA7XkJHRP2DgH2JjDRLp81",
  "metadata": "env=prod",
  "name": "prod-vault",
  "updated_at": "2025-09-04T10:11:43Z",
  "uri": "https://api.ngrok.com/vaults/vault_32ELIL9nzEhwlvjSpNSI6xXGNcE"
}

Fields

Name	Type	Description
`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

Update Vault

Update an existing Vault by ID

Request

PATCH /vaults/{id}

Example Request

curl \
-X PATCH \
-H "Authorization: Bearer {API_KEY}" \
-H "Content-Type: application/json" \
-H "Ngrok-Version: 2" \
-d '{"metadata":"{\"environment\": \"production\"}"}' \
https://api.ngrok.com/vaults/vault_32ELIL9nzEhwlvjSpNSI6xXGNcE

Parameters

Name	Type	Description
`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

Returns a 200 response on success

Example Response

{
  "created_at": "2025-09-04T10:11:43Z",
  "created_by": "usr_32ELAUA7XkJHRP2DgH2JjDRLp81",
  "description": "Production Vault",
  "id": "vault_32ELIL9nzEhwlvjSpNSI6xXGNcE",
  "last_updated_by": "usr_32ELAUA7XkJHRP2DgH2JjDRLp81",
  "metadata": "{\"environment\": \"production\"}",
  "name": "prod-vault",
  "updated_at": "2025-09-04T10:11:43Z",
  "uri": "https://api.ngrok.com/vaults/vault_32ELIL9nzEhwlvjSpNSI6xXGNcE"
}

Fields

Name	Type	Description
`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

Delete Vault

Delete a Vault

Request

DELETE /vaults/{id}

Example Request

curl \
-X DELETE \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/vaults/vault_32ELIL9nzEhwlvjSpNSI6xXGNcE

Response

Returns a 204 response with no body on success

Get Vault

Get a Vault by ID

Request

GET /vaults/{id}

Example Request

curl \
-X GET \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/vaults/vault_32ELIL9nzEhwlvjSpNSI6xXGNcE

Response

Returns a 200 response on success

Example Response

{
  "created_at": "2025-09-04T10:11:43Z",
  "created_by": "usr_32ELAUA7XkJHRP2DgH2JjDRLp81",
  "description": "Production Vault",
  "id": "vault_32ELIL9nzEhwlvjSpNSI6xXGNcE",
  "last_updated_by": "usr_32ELAUA7XkJHRP2DgH2JjDRLp81",
  "metadata": "env=prod",
  "name": "prod-vault",
  "updated_at": "2025-09-04T10:11:43Z",
  "uri": "https://api.ngrok.com/vaults/vault_32ELIL9nzEhwlvjSpNSI6xXGNcE"
}

Fields

Name	Type	Description
`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

GetSecretsByVault Vault

Get Secrets by Vault ID

Request

GET /vaults/{id}/secrets

Example Request

curl \
-X GET \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/vaults/vault_32ELIL9nzEhwlvjSpNSI6xXGNcE/secrets

Response

Returns a 200 response on success

Example Response

{
  "next_page_uri": null,
  "secrets": [],
  "uri": "https://api.ngrok.com/vaults/vault_32ELIL9nzEhwlvjSpNSI6xXGNcE/secrets"
}

Fields

Name	Type	Description
`secrets`	Secret	The list of Secrets for this account
`uri`	string
`next_page_uri`	string	URI of the next page of results, or null if there is no next page

Secret fields

Name	Type	Description
`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`	Ref	Reference to who created this Secret
`last_updated_by`	Ref	Reference to who created this Secret
`vault`	Ref	Reference to the vault the secret is stored in

Ref fields

Name	Type	Description
`id`	string	a resource identifier
`uri`	string	a uri for locating a resource

List Vaults

List all Vaults owned by account

Request

GET /vaults

Example Request

curl \
-X GET \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/vaults

Response

Returns a 200 response on success

Example Response

{
  "next_page_uri": null,
  "uri": "https://api.ngrok.com/vaults",
  "vaults": [
    {
      "created_at": "2025-09-04T10:11:43Z",
      "created_by": "usr_32ELAUA7XkJHRP2DgH2JjDRLp81",
      "description": "Production Vault",
      "id": "vault_32ELIL9nzEhwlvjSpNSI6xXGNcE",
      "last_updated_by": "usr_32ELAUA7XkJHRP2DgH2JjDRLp81",
      "metadata": "env=prod",
      "name": "prod-vault",
      "updated_at": "2025-09-04T10:11:43Z",
      "uri": "https://api.ngrok.com/vaults/vault_32ELIL9nzEhwlvjSpNSI6xXGNcE"
    }
  ]
}

Fields

Name	Type	Description
`vaults`	Vault	The list of Vaults for this account
`uri`	string
`next_page_uri`	string	URI of the next page of results, or null if there is no next page

Vault fields

Name	Type	Description
`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

Universal Gateway

Traffic Policy

Secure Tunnels

Observability

IAM

SSH Certificates

Partners

​Create Vault

​Request

​Example Request

​Parameters

​Response

​Example Response

​Fields

​Update Vault

​Request

​Example Request

​Parameters

​Response

​Example Response

​Fields

​Delete Vault

​Request

​Example Request

​Response

​Get Vault

​Request

​Example Request

​Response

​Example Response

​Fields

​GetSecretsByVault Vault

​Request

​Example Request

​Response

​Example Response

​Fields

​Secret fields

​Ref fields

​List Vaults

​Request

​Example Request

​Response

​Example Response

​Fields

​Vault fields

Create Vault

Request

Example Request

Parameters

Response

Example Response

Fields

Update Vault

Request

Example Request

Parameters

Response

Example Response

Fields

Delete Vault

Request

Example Request

Response

Get Vault

Request

Example Request

Response

Example Response

Fields

GetSecretsByVault Vault

Request

Example Request

Response

Example Response

Fields

Secret fields

Ref fields

List Vaults

Request

Example Request

Response

Example Response

Fields

Vault fields