Update a secret
curl --request PATCH \
--url https://api.crevio.co/v1/secrets/{secret_id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"value": "<string>",
"description": "<string>",
"site_ids": [
"<string>"
],
"egress_host": "<string>",
"egress_header": "<string>"
}
'import requests
url = "https://api.crevio.co/v1/secrets/{secret_id}"
payload = {
"value": "<string>",
"description": "<string>",
"site_ids": ["<string>"],
"egress_host": "<string>",
"egress_header": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
value: '<string>',
description: '<string>',
site_ids: ['<string>'],
egress_host: '<string>',
egress_header: '<string>'
})
};
fetch('https://api.crevio.co/v1/secrets/{secret_id}', 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.crevio.co/v1/secrets/{secret_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'value' => '<string>',
'description' => '<string>',
'site_ids' => [
'<string>'
],
'egress_host' => '<string>',
'egress_header' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.crevio.co/v1/secrets/{secret_id}"
payload := strings.NewReader("{\n \"value\": \"<string>\",\n \"description\": \"<string>\",\n \"site_ids\": [\n \"<string>\"\n ],\n \"egress_host\": \"<string>\",\n \"egress_header\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<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.patch("https://api.crevio.co/v1/secrets/{secret_id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"value\": \"<string>\",\n \"description\": \"<string>\",\n \"site_ids\": [\n \"<string>\"\n ],\n \"egress_host\": \"<string>\",\n \"egress_header\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.crevio.co/v1/secrets/{secret_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"value\": \"<string>\",\n \"description\": \"<string>\",\n \"site_ids\": [\n \"<string>\"\n ],\n \"egress_host\": \"<string>\",\n \"egress_header\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"object": "<string>",
"id": "<string>",
"name": "<string>",
"target": "<string>",
"scope": "<string>",
"site_id": "<string>",
"site_ids": {},
"description": "<string>",
"egress_host": "<string>",
"egress_header": "<string>",
"last4": "<string>",
"value": "<string>",
"created_at": "<string>"
}{
"error": {
"type": "invalid_request_error",
"code": "bad_request",
"message": "The request was malformed or contained invalid parameters"
}
}{
"error": {
"type": "invalid_request_error",
"code": "authentication_required",
"message": "You did not provide an API key."
}
}{
"error": {
"type": "invalid_request_error",
"code": "resource_missing",
"message": "The requested resource was not found"
}
}{
"error": {
"type": "validation_error",
"code": "validation_failed",
"message": "Email is required",
"errors": {
"email": [
"can't be blank"
]
}
}
}{
"error": {
"type": "invalid_request_error",
"code": "rate_limit_exceeded",
"message": "Too many requests. Please retry later."
}
}{
"error": {
"type": "api_error",
"code": "internal_error",
"message": "An unexpected error occurred"
}
}Secrets
Update a secret
Rotates the value or edits the metadata of an existing secret. A secret’s name and owning site are fixed at creation; site_ids applies to shared secrets only.
PATCH
/
secrets
/
{secret_id}
Update a secret
curl --request PATCH \
--url https://api.crevio.co/v1/secrets/{secret_id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"value": "<string>",
"description": "<string>",
"site_ids": [
"<string>"
],
"egress_host": "<string>",
"egress_header": "<string>"
}
'import requests
url = "https://api.crevio.co/v1/secrets/{secret_id}"
payload = {
"value": "<string>",
"description": "<string>",
"site_ids": ["<string>"],
"egress_host": "<string>",
"egress_header": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
value: '<string>',
description: '<string>',
site_ids: ['<string>'],
egress_host: '<string>',
egress_header: '<string>'
})
};
fetch('https://api.crevio.co/v1/secrets/{secret_id}', 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.crevio.co/v1/secrets/{secret_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'value' => '<string>',
'description' => '<string>',
'site_ids' => [
'<string>'
],
'egress_host' => '<string>',
'egress_header' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.crevio.co/v1/secrets/{secret_id}"
payload := strings.NewReader("{\n \"value\": \"<string>\",\n \"description\": \"<string>\",\n \"site_ids\": [\n \"<string>\"\n ],\n \"egress_host\": \"<string>\",\n \"egress_header\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<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.patch("https://api.crevio.co/v1/secrets/{secret_id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"value\": \"<string>\",\n \"description\": \"<string>\",\n \"site_ids\": [\n \"<string>\"\n ],\n \"egress_host\": \"<string>\",\n \"egress_header\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.crevio.co/v1/secrets/{secret_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"value\": \"<string>\",\n \"description\": \"<string>\",\n \"site_ids\": [\n \"<string>\"\n ],\n \"egress_host\": \"<string>\",\n \"egress_header\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"object": "<string>",
"id": "<string>",
"name": "<string>",
"target": "<string>",
"scope": "<string>",
"site_id": "<string>",
"site_ids": {},
"description": "<string>",
"egress_host": "<string>",
"egress_header": "<string>",
"last4": "<string>",
"value": "<string>",
"created_at": "<string>"
}{
"error": {
"type": "invalid_request_error",
"code": "bad_request",
"message": "The request was malformed or contained invalid parameters"
}
}{
"error": {
"type": "invalid_request_error",
"code": "authentication_required",
"message": "You did not provide an API key."
}
}{
"error": {
"type": "invalid_request_error",
"code": "resource_missing",
"message": "The requested resource was not found"
}
}{
"error": {
"type": "validation_error",
"code": "validation_failed",
"message": "Email is required",
"errors": {
"email": [
"can't be blank"
]
}
}
}{
"error": {
"type": "invalid_request_error",
"code": "rate_limit_exceeded",
"message": "Too many requests. Please retry later."
}
}{
"error": {
"type": "api_error",
"code": "internal_error",
"message": "An unexpected error occurred"
}
}Authorizations
API key in the format: Bearer {api_token}
Path Parameters
The secret's prefix ID (e.g., "secret_abc123")
Body
application/json
Replacement value. Omit to leave it untouched.
Human-readable note about what this secret is for.
Sites a shared secret applies to. Empty leaves it dormant — stored, but injected nowhere.
Host the in-chat agent may call with this secret injected server-side. The value itself is never exposed to the model.
Header the secret rides in when calling egress_host (e.g. Authorization).
Response
The updated secret (value masked)
Was this page helpful?

