List secrets
curl --request GET \
--url https://api.brimble.io/core/v1/envs/{projectId}/{environment} \
--header 'x-brimble-key: <api-key>'import requests
url = "https://api.brimble.io/core/v1/envs/{projectId}/{environment}"
headers = {"x-brimble-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-brimble-key': '<api-key>'}};
fetch('https://api.brimble.io/core/v1/envs/{projectId}/{environment}', 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.brimble.io/core/v1/envs/{projectId}/{environment}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-brimble-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"
"net/http"
"io"
)
func main() {
url := "https://api.brimble.io/core/v1/envs/{projectId}/{environment}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-brimble-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.brimble.io/core/v1/envs/{projectId}/{environment}")
.header("x-brimble-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.brimble.io/core/v1/envs/{projectId}/{environment}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-brimble-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"message": "Env fetched successfully",
"data": {
"envs": [
{
"id": "<string>",
"name": "<string>",
"value": "<string>",
"environment": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"user": "<string>",
"avatar": "<string>",
"source": "preview",
"productionValue": "<string>",
"sharedSource": "inherited",
"sourceEnvironment": "<string>",
"inheritable": true,
"sourceProject": "<string>"
}
],
"filterBy": "<string>",
"deployId": {
"name": "<string>",
"key": "<string>",
"commit": {
"sha": "<string>",
"branch": "<string>",
"message": "<string>",
"committer": {
"name": "<string>",
"email": "<string>",
"username": "<string>"
}
},
"source": "<string>",
"status": "AWAITING_CONFIG_APPROVAL",
"project": "<unknown>",
"jobs": [
{
"id": 123,
"name": "<string>"
}
],
"environment": "PREVIEW",
"preview": "<unknown>",
"startTime": "<string>",
"endTime": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"deleted": true,
"_id": "6a81bed11470bfcd2a5dbcfa",
"user": {
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"username": "<string>",
"email_verified_at": "<string>",
"ai_usage_count": 123,
"github": {
"_id": "6a81bed11470bfcd2a5dbcfa",
"git_id": 123,
"installation_ids": [
123
],
"installation_id": "<string>",
"scope": "<string>",
"created_at": 123,
"state": "<string>",
"expires_in": 123,
"expires_at": 123,
"scopes": "<string>"
},
"gitlab": {
"_id": "6a81bed11470bfcd2a5dbcfa",
"git_id": 123,
"installation_ids": [
123
],
"installation_id": "<string>",
"scope": "<string>",
"created_at": 123,
"state": "<string>",
"expires_in": 123,
"expires_at": 123,
"scopes": "<string>"
},
"location": "<string>",
"interests": [
"<string>"
],
"bitbucket": {
"_id": "6a81bed11470bfcd2a5dbcfa",
"git_id": 123,
"installation_ids": [
123
],
"installation_id": "<string>",
"scope": "<string>",
"created_at": 123,
"state": "<string>",
"expires_in": 123,
"expires_at": 123,
"scopes": "<string>"
},
"following": [
{
"_id": "6a81bed11470bfcd2a5dbcfa",
"user_id": "<string>",
"followed_id": "<string>"
}
],
"projects": "<array>",
"teams": [
{
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"size": 123,
"members": [
{
"user": "<unknown>",
"team": "<unknown>",
"role": "CREATOR",
"accepted": true,
"invitedBy": "<unknown>",
"email": "<string>",
"featureOnboarded": true,
"project_environments": [
{
"name": "<string>",
"slug": "<string>",
"owner": "<unknown>",
"isDefault": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"_id": "6a81bed11470bfcd2a5dbcfa",
"team": null,
"inherit_from": null
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"_id": "6a81bed11470bfcd2a5dbcfa",
"custom_role": "6a81bed11470bfcd2a5dbcfa"
}
],
"projects": "<array>",
"ai_usage_count": 123,
"image": "<string>",
"isCreator": true,
"build_minutes": 123,
"build_minutes_last_reset_at": "2023-11-07T05:31:56Z",
"build_minutes_cycle_anchor": "2023-11-07T05:31:56Z",
"spending_limit": 123,
"spending_limit_action": "notify",
"spending_limit_breached_at": "2023-11-07T05:31:56Z",
"build_disabled": true,
"build_disabled_by": "system",
"sandbox_disabled": true,
"sandbox_disabled_by": "system",
"subscription": {
"initial_start_date": "<string>",
"team_id": "<unknown>",
"due_amount": 123,
"admin_id": "<unknown>",
"downgraded": true,
"billable_id": "<unknown>",
"plan_type": "FREE_PLAN",
"status": "active",
"amount": 123,
"transaction_retries": 123,
"debit_date": "<string>",
"start_date": "<string>",
"expiry_date": "<string>",
"reminder_date": "<string>",
"is_pending_downgrade": true,
"grafana_org_id": "<string>",
"job_identifier": "<string>",
"trigger_created": true,
"trigger_created_at": "<string>",
"disabled_at": "2023-11-07T05:31:56Z",
"specifications": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"_id": "6a81bed11470bfcd2a5dbcfa",
"project_id": null
},
"enforce_2fa": true,
"enforce_2fa_at": "2023-11-07T05:31:56Z",
"enforce_2fa_by": "6a81bed11470bfcd2a5dbcfa",
"activation_pending_since": "2023-11-07T05:31:56Z",
"pending_member_invites": [
"<string>"
],
"activation_checked_at": "2023-11-07T05:31:56Z",
"_id": "6a81bed11470bfcd2a5dbcfa",
"concurrent_builds": 123,
"max_concurrent_builds_per_project": 123,
"activation_status": "active"
}
],
"avatar": "<string>",
"freeTrialActive": true,
"activated": true,
"is_waitlist": true,
"build_disabled": true,
"build_disabled_by": "system",
"sandbox_disabled": true,
"sandbox_disabled_by": "system",
"spending_limit": 123,
"spending_limit_action": "notify",
"spending_limit_breached_at": "2023-11-07T05:31:56Z",
"build_minutes": 123,
"llm_tokens": 123,
"llm_tokens_used": 123,
"llm_tokens_team_granted": true,
"disabled": true,
"disabled_at": "2023-11-07T05:31:56Z",
"has_payment_method": true,
"notifications": {
"mute": true,
"email_categories": {
"billing": true,
"activity": true,
"repositories": true,
"updates": true
}
},
"agent_byok_enabled": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"_id": "6a81bed11470bfcd2a5dbcfa",
"company": "<string>",
"origin": {
"installation_id": "<string>",
"namespace_id": "<string>",
"repository_selection": "all"
},
"totp_enabled": true,
"referral_code": "<string>",
"referred_by": "6a81bed11470bfcd2a5dbcfa",
"referred_at": "2023-11-07T05:31:56Z",
"referral_converted_at": "2023-11-07T05:31:56Z",
"referral_rewarded_count": 123,
"referral_domain_credits": 123,
"referral_invoice_credits": 123,
"referral_reward_granted": true,
"concurrent_builds": 123,
"max_concurrent_builds_per_project": 123
},
"team": {
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"size": 123,
"members": [
{
"user": "<unknown>",
"team": "<unknown>",
"role": "CREATOR",
"accepted": true,
"invitedBy": "<unknown>",
"email": "<string>",
"featureOnboarded": true,
"project_environments": [
{
"name": "<string>",
"slug": "<string>",
"owner": "<unknown>",
"isDefault": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"_id": "6a81bed11470bfcd2a5dbcfa",
"team": null,
"inherit_from": null
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"_id": "6a81bed11470bfcd2a5dbcfa",
"custom_role": "6a81bed11470bfcd2a5dbcfa"
}
],
"projects": "<array>",
"ai_usage_count": 123,
"image": "<string>",
"isCreator": true,
"build_minutes": 123,
"build_minutes_last_reset_at": "2023-11-07T05:31:56Z",
"build_minutes_cycle_anchor": "2023-11-07T05:31:56Z",
"spending_limit": 123,
"spending_limit_action": "notify",
"spending_limit_breached_at": "2023-11-07T05:31:56Z",
"build_disabled": true,
"build_disabled_by": "system",
"sandbox_disabled": true,
"sandbox_disabled_by": "system",
"subscription": {
"initial_start_date": "<string>",
"team_id": "<unknown>",
"due_amount": 123,
"admin_id": "<unknown>",
"downgraded": true,
"billable_id": "<unknown>",
"plan_type": "FREE_PLAN",
"status": "active",
"amount": 123,
"transaction_retries": 123,
"debit_date": "<string>",
"start_date": "<string>",
"expiry_date": "<string>",
"reminder_date": "<string>",
"is_pending_downgrade": true,
"grafana_org_id": "<string>",
"job_identifier": "<string>",
"trigger_created": true,
"trigger_created_at": "<string>",
"disabled_at": "2023-11-07T05:31:56Z",
"specifications": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"_id": "6a81bed11470bfcd2a5dbcfa",
"project_id": null
},
"enforce_2fa": true,
"enforce_2fa_at": "2023-11-07T05:31:56Z",
"enforce_2fa_by": "6a81bed11470bfcd2a5dbcfa",
"activation_pending_since": "2023-11-07T05:31:56Z",
"pending_member_invites": [
"<string>"
],
"activation_checked_at": "2023-11-07T05:31:56Z",
"_id": "6a81bed11470bfcd2a5dbcfa",
"concurrent_builds": 123,
"max_concurrent_builds_per_project": 123,
"activation_status": "active"
}
}
}
}{
"errors": [
{
"type": "field",
"value": "<unknown>",
"msg": "Invalid value",
"path": "name",
"location": "body"
}
]
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}Secrets
List secrets
Values are returned encrypted. Use POST /v1/decrypt to read them.
API key scope: env.read
Team role permission: env.read
GET
/
v1
/
envs
/
{projectId}
/
{environment}
List secrets
curl --request GET \
--url https://api.brimble.io/core/v1/envs/{projectId}/{environment} \
--header 'x-brimble-key: <api-key>'import requests
url = "https://api.brimble.io/core/v1/envs/{projectId}/{environment}"
headers = {"x-brimble-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-brimble-key': '<api-key>'}};
fetch('https://api.brimble.io/core/v1/envs/{projectId}/{environment}', 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.brimble.io/core/v1/envs/{projectId}/{environment}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-brimble-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"
"net/http"
"io"
)
func main() {
url := "https://api.brimble.io/core/v1/envs/{projectId}/{environment}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-brimble-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.brimble.io/core/v1/envs/{projectId}/{environment}")
.header("x-brimble-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.brimble.io/core/v1/envs/{projectId}/{environment}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-brimble-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"message": "Env fetched successfully",
"data": {
"envs": [
{
"id": "<string>",
"name": "<string>",
"value": "<string>",
"environment": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"user": "<string>",
"avatar": "<string>",
"source": "preview",
"productionValue": "<string>",
"sharedSource": "inherited",
"sourceEnvironment": "<string>",
"inheritable": true,
"sourceProject": "<string>"
}
],
"filterBy": "<string>",
"deployId": {
"name": "<string>",
"key": "<string>",
"commit": {
"sha": "<string>",
"branch": "<string>",
"message": "<string>",
"committer": {
"name": "<string>",
"email": "<string>",
"username": "<string>"
}
},
"source": "<string>",
"status": "AWAITING_CONFIG_APPROVAL",
"project": "<unknown>",
"jobs": [
{
"id": 123,
"name": "<string>"
}
],
"environment": "PREVIEW",
"preview": "<unknown>",
"startTime": "<string>",
"endTime": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>",
"deleted": true,
"_id": "6a81bed11470bfcd2a5dbcfa",
"user": {
"first_name": "<string>",
"last_name": "<string>",
"email": "<string>",
"username": "<string>",
"email_verified_at": "<string>",
"ai_usage_count": 123,
"github": {
"_id": "6a81bed11470bfcd2a5dbcfa",
"git_id": 123,
"installation_ids": [
123
],
"installation_id": "<string>",
"scope": "<string>",
"created_at": 123,
"state": "<string>",
"expires_in": 123,
"expires_at": 123,
"scopes": "<string>"
},
"gitlab": {
"_id": "6a81bed11470bfcd2a5dbcfa",
"git_id": 123,
"installation_ids": [
123
],
"installation_id": "<string>",
"scope": "<string>",
"created_at": 123,
"state": "<string>",
"expires_in": 123,
"expires_at": 123,
"scopes": "<string>"
},
"location": "<string>",
"interests": [
"<string>"
],
"bitbucket": {
"_id": "6a81bed11470bfcd2a5dbcfa",
"git_id": 123,
"installation_ids": [
123
],
"installation_id": "<string>",
"scope": "<string>",
"created_at": 123,
"state": "<string>",
"expires_in": 123,
"expires_at": 123,
"scopes": "<string>"
},
"following": [
{
"_id": "6a81bed11470bfcd2a5dbcfa",
"user_id": "<string>",
"followed_id": "<string>"
}
],
"projects": "<array>",
"teams": [
{
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"size": 123,
"members": [
{
"user": "<unknown>",
"team": "<unknown>",
"role": "CREATOR",
"accepted": true,
"invitedBy": "<unknown>",
"email": "<string>",
"featureOnboarded": true,
"project_environments": [
{
"name": "<string>",
"slug": "<string>",
"owner": "<unknown>",
"isDefault": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"_id": "6a81bed11470bfcd2a5dbcfa",
"team": null,
"inherit_from": null
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"_id": "6a81bed11470bfcd2a5dbcfa",
"custom_role": "6a81bed11470bfcd2a5dbcfa"
}
],
"projects": "<array>",
"ai_usage_count": 123,
"image": "<string>",
"isCreator": true,
"build_minutes": 123,
"build_minutes_last_reset_at": "2023-11-07T05:31:56Z",
"build_minutes_cycle_anchor": "2023-11-07T05:31:56Z",
"spending_limit": 123,
"spending_limit_action": "notify",
"spending_limit_breached_at": "2023-11-07T05:31:56Z",
"build_disabled": true,
"build_disabled_by": "system",
"sandbox_disabled": true,
"sandbox_disabled_by": "system",
"subscription": {
"initial_start_date": "<string>",
"team_id": "<unknown>",
"due_amount": 123,
"admin_id": "<unknown>",
"downgraded": true,
"billable_id": "<unknown>",
"plan_type": "FREE_PLAN",
"status": "active",
"amount": 123,
"transaction_retries": 123,
"debit_date": "<string>",
"start_date": "<string>",
"expiry_date": "<string>",
"reminder_date": "<string>",
"is_pending_downgrade": true,
"grafana_org_id": "<string>",
"job_identifier": "<string>",
"trigger_created": true,
"trigger_created_at": "<string>",
"disabled_at": "2023-11-07T05:31:56Z",
"specifications": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"_id": "6a81bed11470bfcd2a5dbcfa",
"project_id": null
},
"enforce_2fa": true,
"enforce_2fa_at": "2023-11-07T05:31:56Z",
"enforce_2fa_by": "6a81bed11470bfcd2a5dbcfa",
"activation_pending_since": "2023-11-07T05:31:56Z",
"pending_member_invites": [
"<string>"
],
"activation_checked_at": "2023-11-07T05:31:56Z",
"_id": "6a81bed11470bfcd2a5dbcfa",
"concurrent_builds": 123,
"max_concurrent_builds_per_project": 123,
"activation_status": "active"
}
],
"avatar": "<string>",
"freeTrialActive": true,
"activated": true,
"is_waitlist": true,
"build_disabled": true,
"build_disabled_by": "system",
"sandbox_disabled": true,
"sandbox_disabled_by": "system",
"spending_limit": 123,
"spending_limit_action": "notify",
"spending_limit_breached_at": "2023-11-07T05:31:56Z",
"build_minutes": 123,
"llm_tokens": 123,
"llm_tokens_used": 123,
"llm_tokens_team_granted": true,
"disabled": true,
"disabled_at": "2023-11-07T05:31:56Z",
"has_payment_method": true,
"notifications": {
"mute": true,
"email_categories": {
"billing": true,
"activity": true,
"repositories": true,
"updates": true
}
},
"agent_byok_enabled": true,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"_id": "6a81bed11470bfcd2a5dbcfa",
"company": "<string>",
"origin": {
"installation_id": "<string>",
"namespace_id": "<string>",
"repository_selection": "all"
},
"totp_enabled": true,
"referral_code": "<string>",
"referred_by": "6a81bed11470bfcd2a5dbcfa",
"referred_at": "2023-11-07T05:31:56Z",
"referral_converted_at": "2023-11-07T05:31:56Z",
"referral_rewarded_count": 123,
"referral_domain_credits": 123,
"referral_invoice_credits": 123,
"referral_reward_granted": true,
"concurrent_builds": 123,
"max_concurrent_builds_per_project": 123
},
"team": {
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"size": 123,
"members": [
{
"user": "<unknown>",
"team": "<unknown>",
"role": "CREATOR",
"accepted": true,
"invitedBy": "<unknown>",
"email": "<string>",
"featureOnboarded": true,
"project_environments": [
{
"name": "<string>",
"slug": "<string>",
"owner": "<unknown>",
"isDefault": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"_id": "6a81bed11470bfcd2a5dbcfa",
"team": null,
"inherit_from": null
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"_id": "6a81bed11470bfcd2a5dbcfa",
"custom_role": "6a81bed11470bfcd2a5dbcfa"
}
],
"projects": "<array>",
"ai_usage_count": 123,
"image": "<string>",
"isCreator": true,
"build_minutes": 123,
"build_minutes_last_reset_at": "2023-11-07T05:31:56Z",
"build_minutes_cycle_anchor": "2023-11-07T05:31:56Z",
"spending_limit": 123,
"spending_limit_action": "notify",
"spending_limit_breached_at": "2023-11-07T05:31:56Z",
"build_disabled": true,
"build_disabled_by": "system",
"sandbox_disabled": true,
"sandbox_disabled_by": "system",
"subscription": {
"initial_start_date": "<string>",
"team_id": "<unknown>",
"due_amount": 123,
"admin_id": "<unknown>",
"downgraded": true,
"billable_id": "<unknown>",
"plan_type": "FREE_PLAN",
"status": "active",
"amount": 123,
"transaction_retries": 123,
"debit_date": "<string>",
"start_date": "<string>",
"expiry_date": "<string>",
"reminder_date": "<string>",
"is_pending_downgrade": true,
"grafana_org_id": "<string>",
"job_identifier": "<string>",
"trigger_created": true,
"trigger_created_at": "<string>",
"disabled_at": "2023-11-07T05:31:56Z",
"specifications": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"_id": "6a81bed11470bfcd2a5dbcfa",
"project_id": null
},
"enforce_2fa": true,
"enforce_2fa_at": "2023-11-07T05:31:56Z",
"enforce_2fa_by": "6a81bed11470bfcd2a5dbcfa",
"activation_pending_since": "2023-11-07T05:31:56Z",
"pending_member_invites": [
"<string>"
],
"activation_checked_at": "2023-11-07T05:31:56Z",
"_id": "6a81bed11470bfcd2a5dbcfa",
"concurrent_builds": 123,
"max_concurrent_builds_per_project": 123,
"activation_status": "active"
}
}
}
}{
"errors": [
{
"type": "field",
"value": "<unknown>",
"msg": "Invalid value",
"path": "name",
"location": "body"
}
]
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}Authorizations
ApiKeyAuthBearerAuth
API key created in the dashboard under Settings → API keys. Each key carries permission scopes; every endpoint lists the scope it needs.
Path Parameters
Pattern:
^[a-fA-F0-9]{24}$PREVIEW for secrets used by preview deployments; any other value means production. Use the path without this segment for production.
Available options:
PRODUCTION, PREVIEW Last modified on October 10, 2026
Was this page helpful?