Skip to main content
GET
/
vault_secrets
List
curl --request GET \
  --url https://api.ngrok.com/vault_secrets \
  --header 'Authorization: Bearer <token>' \
  --header 'ngrok-version: <ngrok-version>'
{
  "secrets": [
    {
      "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>"
      }
    }
  ],
  "uri": "<string>",
  "next_page_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

Query Parameters

before_id
string
limit
string

Response

200 - application/json

List all Secrets owned by account

secrets
object[]

The list of Secrets for this account

uri
string

n/a

next_page_uri
string

URI of the next page of results, or null if there is no next page