Create Secure Share Link
curl --request POST \
--url https://api.example.com/secrets/{workspace_id}/{team_id}/{project_id}/{environment_id}/share \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"secret_ids": [
"<string>"
],
"expires_in_minutes": 60,
"max_views": 1
}
'import requests
url = "https://api.example.com/secrets/{workspace_id}/{team_id}/{project_id}/{environment_id}/share"
payload = {
"secret_ids": ["<string>"],
"expires_in_minutes": 60,
"max_views": 1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({secret_ids: ['<string>'], expires_in_minutes: 60, max_views: 1})
};
fetch('https://api.example.com/secrets/{workspace_id}/{team_id}/{project_id}/{environment_id}/share', 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.example.com/secrets/{workspace_id}/{team_id}/{project_id}/{environment_id}/share",
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([
'secret_ids' => [
'<string>'
],
'expires_in_minutes' => 60,
'max_views' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.example.com/secrets/{workspace_id}/{team_id}/{project_id}/{environment_id}/share"
payload := strings.NewReader("{\n \"secret_ids\": [\n \"<string>\"\n ],\n \"expires_in_minutes\": 60,\n \"max_views\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/secrets/{workspace_id}/{team_id}/{project_id}/{environment_id}/share")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"secret_ids\": [\n \"<string>\"\n ],\n \"expires_in_minutes\": 60,\n \"max_views\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/secrets/{workspace_id}/{team_id}/{project_id}/{environment_id}/share")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"secret_ids\": [\n \"<string>\"\n ],\n \"expires_in_minutes\": 60,\n \"max_views\": 1\n}"
response = http.request(request)
puts response.read_body{
"token": "<string>",
"url": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"max_views": 123,
"secret_count": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}SECRET MANAGEMENT
Create Secure Share Link
Mint a single-use (or view-capped) link that hands out secret values without requiring the recipient to hold a workspace account.
Only the token hash and the secret ids live in Redis; the values stay encrypted at rest and are decrypted on redemption.
POST
/
secrets
/
{workspace_id}
/
{team_id}
/
{project_id}
/
{environment_id}
/
share
Create Secure Share Link
curl --request POST \
--url https://api.example.com/secrets/{workspace_id}/{team_id}/{project_id}/{environment_id}/share \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"secret_ids": [
"<string>"
],
"expires_in_minutes": 60,
"max_views": 1
}
'import requests
url = "https://api.example.com/secrets/{workspace_id}/{team_id}/{project_id}/{environment_id}/share"
payload = {
"secret_ids": ["<string>"],
"expires_in_minutes": 60,
"max_views": 1
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({secret_ids: ['<string>'], expires_in_minutes: 60, max_views: 1})
};
fetch('https://api.example.com/secrets/{workspace_id}/{team_id}/{project_id}/{environment_id}/share', 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.example.com/secrets/{workspace_id}/{team_id}/{project_id}/{environment_id}/share",
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([
'secret_ids' => [
'<string>'
],
'expires_in_minutes' => 60,
'max_views' => 1
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.example.com/secrets/{workspace_id}/{team_id}/{project_id}/{environment_id}/share"
payload := strings.NewReader("{\n \"secret_ids\": [\n \"<string>\"\n ],\n \"expires_in_minutes\": 60,\n \"max_views\": 1\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/secrets/{workspace_id}/{team_id}/{project_id}/{environment_id}/share")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"secret_ids\": [\n \"<string>\"\n ],\n \"expires_in_minutes\": 60,\n \"max_views\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/secrets/{workspace_id}/{team_id}/{project_id}/{environment_id}/share")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"secret_ids\": [\n \"<string>\"\n ],\n \"expires_in_minutes\": 60,\n \"max_views\": 1\n}"
response = http.request(request)
puts response.read_body{
"token": "<string>",
"url": "<string>",
"expires_at": "2023-11-07T05:31:56Z",
"max_views": 123,
"secret_count": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
OAuth2PasswordBearerAPIKeyHeader
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
Path Parameters
Body
application/json
⌘I