Criar um novo segredo com um valor inicial
curl --request POST \
--url https://secrets.{region}.basaltic.sh/v1/secrets \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "prod/api/stripe-key",
"value": "c3VwZXItc2VjcmV0LXZhbHVl",
"description": "Stripe live secret key for the payments service",
"tags": {
"environment": "production",
"team": "backend"
},
"recovery_window_days": 7,
"kms_key": "crn:kms:sa-saopaulo-1:acme:key/service-key"
}
'import requests
url = "https://secrets.{region}.basaltic.sh/v1/secrets"
payload = {
"name": "prod/api/stripe-key",
"value": "c3VwZXItc2VjcmV0LXZhbHVl",
"description": "Stripe live secret key for the payments service",
"tags": {
"environment": "production",
"team": "backend"
},
"recovery_window_days": 7,
"kms_key": "crn:kms:sa-saopaulo-1:acme:key/service-key"
}
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({
name: 'prod/api/stripe-key',
value: 'c3VwZXItc2VjcmV0LXZhbHVl',
description: 'Stripe live secret key for the payments service',
tags: {environment: 'production', team: 'backend'},
recovery_window_days: 7,
kms_key: 'crn:kms:sa-saopaulo-1:acme:key/service-key'
})
};
fetch('https://secrets.{region}.basaltic.sh/v1/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://secrets.{region}.basaltic.sh/v1/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' => 'prod/api/stripe-key',
'value' => 'c3VwZXItc2VjcmV0LXZhbHVl',
'description' => 'Stripe live secret key for the payments service',
'tags' => [
'environment' => 'production',
'team' => 'backend'
],
'recovery_window_days' => 7,
'kms_key' => 'crn:kms:sa-saopaulo-1:acme:key/service-key'
]),
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://secrets.{region}.basaltic.sh/v1/secrets"
payload := strings.NewReader("{\n \"name\": \"prod/api/stripe-key\",\n \"value\": \"c3VwZXItc2VjcmV0LXZhbHVl\",\n \"description\": \"Stripe live secret key for the payments service\",\n \"tags\": {\n \"environment\": \"production\",\n \"team\": \"backend\"\n },\n \"recovery_window_days\": 7,\n \"kms_key\": \"crn:kms:sa-saopaulo-1:acme:key/service-key\"\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://secrets.{region}.basaltic.sh/v1/secrets")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"prod/api/stripe-key\",\n \"value\": \"c3VwZXItc2VjcmV0LXZhbHVl\",\n \"description\": \"Stripe live secret key for the payments service\",\n \"tags\": {\n \"environment\": \"production\",\n \"team\": \"backend\"\n },\n \"recovery_window_days\": 7,\n \"kms_key\": \"crn:kms:sa-saopaulo-1:acme:key/service-key\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://secrets.{region}.basaltic.sh/v1/secrets")
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 \"name\": \"prod/api/stripe-key\",\n \"value\": \"c3VwZXItc2VjcmV0LXZhbHVl\",\n \"description\": \"Stripe live secret key for the payments service\",\n \"tags\": {\n \"environment\": \"production\",\n \"team\": \"backend\"\n },\n \"recovery_window_days\": 7,\n \"kms_key\": \"crn:kms:sa-saopaulo-1:acme:key/service-key\"\n}"
response = http.request(request)
puts response.read_body{
"secret": {
"id": "a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"name": "prod/api/stripe-key",
"crn": "crn:secrets:sa-saopaulo-1:my-account:secret/prod/api/stripe-key",
"managed": false,
"recovery_window_days": 7,
"created_at": "2026-01-15T09:30:00Z",
"updated_at": "2026-01-18T11:45:00Z",
"description": "Stripe live secret key for the payments service",
"tags": {
"environment": "production",
"team": "backend"
},
"kms_key_unavailable": true,
"kms_key_crn": "crn:kms:sa-saopaulo-1:acme:key/service-key",
"deleted_at": "2026-01-20T14:05:00Z",
"scheduled_purge_at": "2026-01-27T14:05:00Z",
"current_version": 3
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "ACCESS_DENIED",
"message": "You don't have permission to perform this action",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"error": {
"code": "IDEMPOTENCY_KEY_REUSED",
"message": "This Idempotency-Key was already used with a different request payload",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "An internal error occurred",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}Segredos
Criar um novo segredo com um valor inicial
POST
/
v1
/
secrets
Criar um novo segredo com um valor inicial
curl --request POST \
--url https://secrets.{region}.basaltic.sh/v1/secrets \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "prod/api/stripe-key",
"value": "c3VwZXItc2VjcmV0LXZhbHVl",
"description": "Stripe live secret key for the payments service",
"tags": {
"environment": "production",
"team": "backend"
},
"recovery_window_days": 7,
"kms_key": "crn:kms:sa-saopaulo-1:acme:key/service-key"
}
'import requests
url = "https://secrets.{region}.basaltic.sh/v1/secrets"
payload = {
"name": "prod/api/stripe-key",
"value": "c3VwZXItc2VjcmV0LXZhbHVl",
"description": "Stripe live secret key for the payments service",
"tags": {
"environment": "production",
"team": "backend"
},
"recovery_window_days": 7,
"kms_key": "crn:kms:sa-saopaulo-1:acme:key/service-key"
}
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({
name: 'prod/api/stripe-key',
value: 'c3VwZXItc2VjcmV0LXZhbHVl',
description: 'Stripe live secret key for the payments service',
tags: {environment: 'production', team: 'backend'},
recovery_window_days: 7,
kms_key: 'crn:kms:sa-saopaulo-1:acme:key/service-key'
})
};
fetch('https://secrets.{region}.basaltic.sh/v1/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://secrets.{region}.basaltic.sh/v1/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' => 'prod/api/stripe-key',
'value' => 'c3VwZXItc2VjcmV0LXZhbHVl',
'description' => 'Stripe live secret key for the payments service',
'tags' => [
'environment' => 'production',
'team' => 'backend'
],
'recovery_window_days' => 7,
'kms_key' => 'crn:kms:sa-saopaulo-1:acme:key/service-key'
]),
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://secrets.{region}.basaltic.sh/v1/secrets"
payload := strings.NewReader("{\n \"name\": \"prod/api/stripe-key\",\n \"value\": \"c3VwZXItc2VjcmV0LXZhbHVl\",\n \"description\": \"Stripe live secret key for the payments service\",\n \"tags\": {\n \"environment\": \"production\",\n \"team\": \"backend\"\n },\n \"recovery_window_days\": 7,\n \"kms_key\": \"crn:kms:sa-saopaulo-1:acme:key/service-key\"\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://secrets.{region}.basaltic.sh/v1/secrets")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"prod/api/stripe-key\",\n \"value\": \"c3VwZXItc2VjcmV0LXZhbHVl\",\n \"description\": \"Stripe live secret key for the payments service\",\n \"tags\": {\n \"environment\": \"production\",\n \"team\": \"backend\"\n },\n \"recovery_window_days\": 7,\n \"kms_key\": \"crn:kms:sa-saopaulo-1:acme:key/service-key\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://secrets.{region}.basaltic.sh/v1/secrets")
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 \"name\": \"prod/api/stripe-key\",\n \"value\": \"c3VwZXItc2VjcmV0LXZhbHVl\",\n \"description\": \"Stripe live secret key for the payments service\",\n \"tags\": {\n \"environment\": \"production\",\n \"team\": \"backend\"\n },\n \"recovery_window_days\": 7,\n \"kms_key\": \"crn:kms:sa-saopaulo-1:acme:key/service-key\"\n}"
response = http.request(request)
puts response.read_body{
"secret": {
"id": "a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"name": "prod/api/stripe-key",
"crn": "crn:secrets:sa-saopaulo-1:my-account:secret/prod/api/stripe-key",
"managed": false,
"recovery_window_days": 7,
"created_at": "2026-01-15T09:30:00Z",
"updated_at": "2026-01-18T11:45:00Z",
"description": "Stripe live secret key for the payments service",
"tags": {
"environment": "production",
"team": "backend"
},
"kms_key_unavailable": true,
"kms_key_crn": "crn:kms:sa-saopaulo-1:acme:key/service-key",
"deleted_at": "2026-01-20T14:05:00Z",
"scheduled_purge_at": "2026-01-27T14:05:00Z",
"current_version": 3
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "ACCESS_DENIED",
"message": "You don't have permission to perform this action",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"params": {
"instances": 2,
"pools": 0
}
}
}{
"error": {
"code": "IDEMPOTENCY_KEY_REUSED",
"message": "This Idempotency-Key was already used with a different request payload",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "An internal error occurred",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}Requer a ação do IAM
secrets:CreateSecret. Consulte permissões de segredos para obter a lista completa, o que cada uma cobre e um exemplo de política.Autorizações
Um token bearer OAuth 2.0, enviado como Authorization: Bearer <token>. Esta é a forma recomendada de autenticação.
Obtenha o token trocando o par de chaves de acesso de uma conta de serviço em POST /v1/oauth/token com grant_type=client_credentials. Esse é o fluxo padrão de credenciais de cliente; bibliotecas compatíveis com OAuth podem obter e renovar o token para você.
curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
https://iam.basaltic.sh/v1/oauth/token
Os tokens duram uma hora por padrão. O mesmo par de chaves de acesso também serve como credencial AWS SigV4 para o endpoint de objetos compatível com S3, que aceita somente esse método de autenticação.
Cabeçalhos
Chave opcional gerada pelo cliente que torna uma criação segura para reprodução. A reintentar uma solicitação com a mesma chave retorna o resultado original literalmente em vez de criar um recurso duplicado. A reutilização de uma chave com um corpo de solicitação diferente é rejeitada (422); uma solicitação cuja chave ainda está sendo processada retorna 409. Os registros são honrados por 24 horas. Use um UUID ou token exclusivo semelhante.
Maximum string length:
255Corpo
application/json
Único dentro da conta de chamada. Os nomes de recursos não devem começar com o prefixo literal crn: ou ser UUIDs (formas canônicas, compactas, entre colchetes ou urn:uuid:, em qualquer caso).
Exemplo:
"prod/api/stripe-key"
Base64 dos bytes de valor inicial (1 byte - 64 KiB).
Exemplo:
"c3VwZXItc2VjcmV0LXZhbHVl"
Exemplo:
"Stripe live secret key for the payments service"
Show child attributes
Show child attributes
Exemplo:
{
"environment": "production",
"team": "backend"
}
Intervalo obrigatório:
1 <= x <= 30Exemplo:
7
UUID, CRN ou nome de escopo de conta de uma chave KMS gerenciada pelo cliente para criptografar esse segredo. Omita para usar a chave padrão gerenciada pela plataforma. A chave deve estar habilitada e ter uso de criptografia/descriptografia.
Exemplo:
"crn:kms:sa-saopaulo-1:acme:key/service-key"
Resposta
Segredo criado na versão 1.
Show child attributes
Show child attributes