Skip to main content
POST
/
vaults
Create
curl --request POST \
  --url https://api.ngrok.com/vaults \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'ngrok-version: <ngrok-version>' \
  --data '
{
  "name": "<string>",
  "metadata": "<string>",
  "description": "<string>"
}
'
import requests

url = "https://api.ngrok.com/vaults"

payload = {
    "name": "<string>",
    "metadata": "<string>",
    "description": "<string>"
}
headers = {
    "ngrok-version": "<ngrok-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {
    'ngrok-version': '<ngrok-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({name: '<string>', metadata: '<string>', description: '<string>'})
};

fetch('https://api.ngrok.com/vaults', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ngrok.com/vaults",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'metadata' => '<string>',
    'description' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "ngrok-version: <ngrok-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ngrok.com/vaults"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"metadata\": \"<string>\",\n  \"description\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("ngrok-version", "<ngrok-version>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.ngrok.com/vaults")
  .header("ngrok-version", "<ngrok-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"metadata\": \"<string>\",\n  \"description\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.ngrok.com/vaults")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["ngrok-version"] = '<ngrok-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"metadata\": \"<string>\",\n  \"description\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "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

Body

application/json
name
string

Name of vault

metadata
string

Arbitrary user-defined metadata for this Vault

description
string

description of Vault

Response

201 - application/json

Create a new Vault

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