Create
curl --request POST \
--url https://api.ngrok.com/vault_secrets \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'ngrok-version: <ngrok-version>' \
--data '
{
"name": "<string>",
"value": "<string>",
"metadata": "<string>",
"description": "<string>",
"vault_id": "<string>",
"vault_name": "<string>"
}
'import requests
url = "https://api.ngrok.com/vault_secrets"
payload = {
"name": "<string>",
"value": "<string>",
"metadata": "<string>",
"description": "<string>",
"vault_id": "<string>",
"vault_name": "<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>',
value: '<string>',
metadata: '<string>',
description: '<string>',
vault_id: '<string>',
vault_name: '<string>'
})
};
fetch('https://api.ngrok.com/vault_secrets', 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/vault_secrets",
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>',
'value' => '<string>',
'metadata' => '<string>',
'description' => '<string>',
'vault_id' => '<string>',
'vault_name' => '<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/vault_secrets"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"metadata\": \"<string>\",\n \"description\": \"<string>\",\n \"vault_id\": \"<string>\",\n \"vault_name\": \"<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/vault_secrets")
.header("ngrok-version", "<ngrok-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"metadata\": \"<string>\",\n \"description\": \"<string>\",\n \"vault_id\": \"<string>\",\n \"vault_name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ngrok.com/vault_secrets")
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 \"value\": \"<string>\",\n \"metadata\": \"<string>\",\n \"description\": \"<string>\",\n \"vault_id\": \"<string>\",\n \"vault_name\": \"<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": {
"id": "<string>",
"uri": "<string>"
},
"last_updated_by": {
"id": "<string>",
"uri": "<string>"
},
"vault": {
"id": "<string>",
"uri": "<string>"
},
"vault_name": "<string>"
}Secrets
Create
Create a new Secret
POST
/
vault_secrets
Create
curl --request POST \
--url https://api.ngrok.com/vault_secrets \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'ngrok-version: <ngrok-version>' \
--data '
{
"name": "<string>",
"value": "<string>",
"metadata": "<string>",
"description": "<string>",
"vault_id": "<string>",
"vault_name": "<string>"
}
'import requests
url = "https://api.ngrok.com/vault_secrets"
payload = {
"name": "<string>",
"value": "<string>",
"metadata": "<string>",
"description": "<string>",
"vault_id": "<string>",
"vault_name": "<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>',
value: '<string>',
metadata: '<string>',
description: '<string>',
vault_id: '<string>',
vault_name: '<string>'
})
};
fetch('https://api.ngrok.com/vault_secrets', 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/vault_secrets",
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>',
'value' => '<string>',
'metadata' => '<string>',
'description' => '<string>',
'vault_id' => '<string>',
'vault_name' => '<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/vault_secrets"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"metadata\": \"<string>\",\n \"description\": \"<string>\",\n \"vault_id\": \"<string>\",\n \"vault_name\": \"<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/vault_secrets")
.header("ngrok-version", "<ngrok-version>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"metadata\": \"<string>\",\n \"description\": \"<string>\",\n \"vault_id\": \"<string>\",\n \"vault_name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ngrok.com/vault_secrets")
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 \"value\": \"<string>\",\n \"metadata\": \"<string>\",\n \"description\": \"<string>\",\n \"vault_id\": \"<string>\",\n \"vault_name\": \"<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": {
"id": "<string>",
"uri": "<string>"
},
"last_updated_by": {
"id": "<string>",
"uri": "<string>"
},
"vault": {
"id": "<string>",
"uri": "<string>"
},
"vault_name": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Body
application/json
Response
201 - application/json
Create a new Secret
identifier for Secret
URI of this Secret API resource
Timestamp when the Secret was created (RFC 3339 format)
Timestamp when the Secret was last updated (RFC 3339 format)
Name of secret
description of Secret
Arbitrary user-defined metadata for this Secret
Reference to who created this Secret
Show child attributes
Show child attributes
Reference to who created this Secret
Show child attributes
Show child attributes
Reference to the vault the secret is stored in
Show child attributes
Show child attributes
Name of the vault the secret is stored in
Was this page helpful?
⌘I