Secrets
Create a secret
Stores a credential under the caller’s team. The plaintext is
envelope-encrypted at rest and is never returned by any API.
At sandbox-create time, bind the secret to an environment-variable
name via the secrets map on POST /sandboxes; the agent sees a
proxy token in env and the in-host enforcement daemon swaps it for
the real value at egress.
Use provider for built-in shortcuts (e.g. anthropic, openai,
github, stripe) which auto-fill the auth scheme and allowed
upstream hosts. Use auth + hosts for a custom integration.
POST
/
secrets
Create a secret
curl --request POST \
--url https://api.superserve.ai/secrets \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"value": "<string>",
"provider": "<string>",
"auth": {
"header": "<string>",
"prefix": "<string>",
"username": "<string>",
"headers": {}
},
"hosts": [
"<string>"
]
}
'import requests
url = "https://api.superserve.ai/secrets"
payload = {
"name": "<string>",
"value": "<string>",
"provider": "<string>",
"auth": {
"header": "<string>",
"prefix": "<string>",
"username": "<string>",
"headers": {}
},
"hosts": ["<string>"]
}
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>',
value: '<string>',
provider: '<string>',
auth: {header: '<string>', prefix: '<string>', username: '<string>', headers: {}},
hosts: ['<string>']
})
};
fetch('https://api.superserve.ai/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.superserve.ai/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>',
'provider' => '<string>',
'auth' => [
'header' => '<string>',
'prefix' => '<string>',
'username' => '<string>',
'headers' => [
]
],
'hosts' => [
'<string>'
]
]),
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.superserve.ai/secrets"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"provider\": \"<string>\",\n \"auth\": {\n \"header\": \"<string>\",\n \"prefix\": \"<string>\",\n \"username\": \"<string>\",\n \"headers\": {}\n },\n \"hosts\": [\n \"<string>\"\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.superserve.ai/secrets")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"provider\": \"<string>\",\n \"auth\": {\n \"header\": \"<string>\",\n \"prefix\": \"<string>\",\n \"username\": \"<string>\",\n \"headers\": {}\n },\n \"hosts\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.superserve.ai/secrets")
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 \"value\": \"<string>\",\n \"provider\": \"<string>\",\n \"auth\": {\n \"header\": \"<string>\",\n \"prefix\": \"<string>\",\n \"username\": \"<string>\",\n \"headers\": {}\n },\n \"hosts\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"auth_type": "bearer",
"auth_config": {},
"hosts": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"provider_shortcut": "<string>",
"last_used_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}Authorizations
Body
application/json
Identifier used to reference the secret later (e.g. in the secrets map on POST /sandboxes).
Maximum string length:
128Pattern:
^[A-Za-z_][A-Za-z0-9_-]*$Cleartext credential. Encrypted at rest; never returned.
Maximum string length:
8192Built-in provider shortcut (e.g. anthropic, openai, github, stripe). When set, auto-fills auth scheme and allowed upstream hosts. Mutually exclusive with auth and hosts. github emits a per_host config so the same PAT works for both api.github.com REST (Bearer) and github.com git over HTTPS (Basic with x-access-token).
Egress auth shape. Use the single-rule form (type + type-specific
fields) for credentials that authenticate the same way on every host.
Use per_host when the same credential needs different auth schemes
on different hosts of the same provider — for example one host
accepts Bearer while another accepts Basic with a fixed username.
Single-rule and per_host are mutually exclusive.
- Option 1
- Option 2
Show child attributes
Show child attributes
Upstream allow list. Required when auth is set. Each entry is a hostname or single-level wildcard (e.g. api.example.com, *.example.com).
Maximum array length:
16Response
Secret created
per_host indicates a multi-rule secret; the resolved rules are in auth_config.per_host.
Available options:
bearer, basic, api-key, custom, per_host Resolved auth scheme details (no cleartext value).
Provider shortcut used at creation, if any.
Timestamp of the most recent egress that used this secret.
⌘I
Create a secret
curl --request POST \
--url https://api.superserve.ai/secrets \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"value": "<string>",
"provider": "<string>",
"auth": {
"header": "<string>",
"prefix": "<string>",
"username": "<string>",
"headers": {}
},
"hosts": [
"<string>"
]
}
'import requests
url = "https://api.superserve.ai/secrets"
payload = {
"name": "<string>",
"value": "<string>",
"provider": "<string>",
"auth": {
"header": "<string>",
"prefix": "<string>",
"username": "<string>",
"headers": {}
},
"hosts": ["<string>"]
}
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>',
value: '<string>',
provider: '<string>',
auth: {header: '<string>', prefix: '<string>', username: '<string>', headers: {}},
hosts: ['<string>']
})
};
fetch('https://api.superserve.ai/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.superserve.ai/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>',
'provider' => '<string>',
'auth' => [
'header' => '<string>',
'prefix' => '<string>',
'username' => '<string>',
'headers' => [
]
],
'hosts' => [
'<string>'
]
]),
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.superserve.ai/secrets"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"provider\": \"<string>\",\n \"auth\": {\n \"header\": \"<string>\",\n \"prefix\": \"<string>\",\n \"username\": \"<string>\",\n \"headers\": {}\n },\n \"hosts\": [\n \"<string>\"\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.superserve.ai/secrets")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"provider\": \"<string>\",\n \"auth\": {\n \"header\": \"<string>\",\n \"prefix\": \"<string>\",\n \"username\": \"<string>\",\n \"headers\": {}\n },\n \"hosts\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.superserve.ai/secrets")
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 \"value\": \"<string>\",\n \"provider\": \"<string>\",\n \"auth\": {\n \"header\": \"<string>\",\n \"prefix\": \"<string>\",\n \"username\": \"<string>\",\n \"headers\": {}\n },\n \"hosts\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"auth_type": "bearer",
"auth_config": {},
"hosts": [
"<string>"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"provider_shortcut": "<string>",
"last_used_at": "2023-11-07T05:31:56Z"
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
}
}