curl --request POST \
--url https://api.hyperbrowser.ai/api/vaults \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"description": "",
"source": {
"type": "stored"
},
"entries": {
"USERNAME": {
"name": "github-username"
},
"PASSWORD": {
"name": "github-password"
}
}
}
'import requests
url = "https://api.hyperbrowser.ai/api/vaults"
payload = {
"name": "<string>",
"description": "",
"source": { "type": "stored" },
"entries": {
"USERNAME": { "name": "github-username" },
"PASSWORD": { "name": "github-password" }
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '',
source: {type: 'stored'},
entries: {USERNAME: {name: 'github-username'}, PASSWORD: {name: 'github-password'}}
})
};
fetch('https://api.hyperbrowser.ai/api/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.hyperbrowser.ai/api/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>',
'description' => '',
'source' => [
'type' => 'stored'
],
'entries' => [
'USERNAME' => [
'name' => 'github-username'
],
'PASSWORD' => [
'name' => 'github-password'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.hyperbrowser.ai/api/vaults"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"\",\n \"source\": {\n \"type\": \"stored\"\n },\n \"entries\": {\n \"USERNAME\": {\n \"name\": \"github-username\"\n },\n \"PASSWORD\": {\n \"name\": \"github-password\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.hyperbrowser.ai/api/vaults")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"\",\n \"source\": {\n \"type\": \"stored\"\n },\n \"entries\": {\n \"USERNAME\": {\n \"name\": \"github-username\"\n },\n \"PASSWORD\": {\n \"name\": \"github-password\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperbrowser.ai/api/vaults")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"\",\n \"source\": {\n \"type\": \"stored\"\n },\n \"entries\": {\n \"USERNAME\": {\n \"name\": \"github-username\"\n },\n \"PASSWORD\": {\n \"name\": \"github-password\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"entries": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"source": {
"type": "stored",
"tokenSecret": {
"name": "<string>",
"secretId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"vault": "<string>"
}
}{
"code": "<string>",
"message": "<string>",
"error": "<string>",
"requiredScopes": [
"<string>"
],
"retryable": true,
"details": {}
}{
"code": "<string>",
"message": "<string>",
"error": "<string>",
"requiredScopes": [
"<string>"
],
"retryable": true,
"details": {}
}{
"code": "<string>",
"message": "<string>",
"error": "<string>",
"requiredScopes": [
"<string>"
],
"retryable": true,
"details": {}
}{
"code": "<string>",
"message": "<string>",
"error": "<string>",
"requiredScopes": [
"<string>"
],
"retryable": true,
"details": {}
}{
"code": "<string>",
"message": "<string>",
"error": "<string>",
"requiredScopes": [
"<string>"
],
"retryable": true,
"details": {}
}{
"code": "<string>",
"message": "<string>",
"error": "<string>",
"requiredScopes": [
"<string>"
],
"retryable": true,
"details": {}
}Create a vault
Create a vault of stored secrets or a linked 1Password vault.
curl --request POST \
--url https://api.hyperbrowser.ai/api/vaults \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"description": "",
"source": {
"type": "stored"
},
"entries": {
"USERNAME": {
"name": "github-username"
},
"PASSWORD": {
"name": "github-password"
}
}
}
'import requests
url = "https://api.hyperbrowser.ai/api/vaults"
payload = {
"name": "<string>",
"description": "",
"source": { "type": "stored" },
"entries": {
"USERNAME": { "name": "github-username" },
"PASSWORD": { "name": "github-password" }
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '',
source: {type: 'stored'},
entries: {USERNAME: {name: 'github-username'}, PASSWORD: {name: 'github-password'}}
})
};
fetch('https://api.hyperbrowser.ai/api/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.hyperbrowser.ai/api/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>',
'description' => '',
'source' => [
'type' => 'stored'
],
'entries' => [
'USERNAME' => [
'name' => 'github-username'
],
'PASSWORD' => [
'name' => 'github-password'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.hyperbrowser.ai/api/vaults"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"\",\n \"source\": {\n \"type\": \"stored\"\n },\n \"entries\": {\n \"USERNAME\": {\n \"name\": \"github-username\"\n },\n \"PASSWORD\": {\n \"name\": \"github-password\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.hyperbrowser.ai/api/vaults")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"\",\n \"source\": {\n \"type\": \"stored\"\n },\n \"entries\": {\n \"USERNAME\": {\n \"name\": \"github-username\"\n },\n \"PASSWORD\": {\n \"name\": \"github-password\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperbrowser.ai/api/vaults")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"\",\n \"source\": {\n \"type\": \"stored\"\n },\n \"entries\": {\n \"USERNAME\": {\n \"name\": \"github-username\"\n },\n \"PASSWORD\": {\n \"name\": \"github-password\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"description": "<string>",
"entries": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"source": {
"type": "stored",
"tokenSecret": {
"name": "<string>",
"secretId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"vault": "<string>"
}
}{
"code": "<string>",
"message": "<string>",
"error": "<string>",
"requiredScopes": [
"<string>"
],
"retryable": true,
"details": {}
}{
"code": "<string>",
"message": "<string>",
"error": "<string>",
"requiredScopes": [
"<string>"
],
"retryable": true,
"details": {}
}{
"code": "<string>",
"message": "<string>",
"error": "<string>",
"requiredScopes": [
"<string>"
],
"retryable": true,
"details": {}
}{
"code": "<string>",
"message": "<string>",
"error": "<string>",
"requiredScopes": [
"<string>"
],
"retryable": true,
"details": {}
}{
"code": "<string>",
"message": "<string>",
"error": "<string>",
"requiredScopes": [
"<string>"
],
"retryable": true,
"details": {}
}{
"code": "<string>",
"message": "<string>",
"error": "<string>",
"requiredScopes": [
"<string>"
],
"retryable": true,
"details": {}
}Authorizations
Body
1-128 letters, digits, _ or -, starting with a letter or digit. Unique within your team.
^[a-zA-Z0-9][a-zA-Z0-9_-]{0,127}$Trimmed before it's stored.
1024Where values come from. Defaults to {"type": "stored"}. The type can't change later.
- Stored
- 1Password
Show child attributes
Show child attributes
Environment variable name to entry: secrets for a stored vault, item fields for a 1Password vault (otherwise 400 VAULT_ENTRY_INVALID). Keys are environment variable names: letters, digits and _, not starting with a digit, at most 256 characters. A vault holds at most 32 entries (otherwise 409 VAULT_ENTRY_LIMIT_REACHED).
Show child attributes
Show child attributes
{
"USERNAME": { "name": "github-username" },
"PASSWORD": { "name": "github-password" }
}
Response
Success
A named set of environment variables. Holds no values.
1-128 letters, digits, _ or -, starting with a letter or digit. Unique within your team.
^[a-zA-Z0-9][a-zA-Z0-9_-]{0,127}$1024Environment variable name to entry.
Show child attributes
Show child attributes
Where the vault's values come from. stored: your secrets. 1password: a linked 1Password vault, read with the service account token in tokenSecret. Treat a missing source as stored.
Show child attributes
Show child attributes
Was this page helpful?