Skip to main content
GET
/
vault_secrets
/
{id}
Get
curl --request GET \
  --url https://api.ngrok.com/vault_secrets/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'ngrok-version: <ngrok-version>'
{
  "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

Path Parameters

​
id
string
required

a resource identifier

Response

200 - application/json

Get a 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