Store plugin secret
Encrypts and stores a secret under a plugin ID and name, replacing any value already there. A configuration entry refers to it as a secret_ref. Names use lowercase letters, digits, '.', '_', and '-'. Fails unless plugin secret encryption is configured. Admin only; API keys are refused.
post
https://<host>/api/v1/plugins/secretsbash
curl --request POST \
--url 'https://<host>/api/v1/plugins/secrets' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{"name":"string","plugin_id":"string","value":"string"}'javascript
const response = await fetch("https://<host>/api/v1/plugins/secrets", {
method: "POST",
headers: {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
},
body: JSON.stringify({
"name": "string",
"plugin_id": "string",
"value": "string"
})
});
const data = await response.json();typescript
interface PluginSecretResponse {
correlation_id?: string;
item?: Record<string, unknown>;
}
const response = await fetch("https://<host>/api/v1/plugins/secrets", {
method: "POST",
headers: {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
},
body: JSON.stringify({
"name": "string",
"plugin_id": "string",
"value": "string"
})
});
if (!response.ok) throw new Error(`${response.status} ${response.statusText}`);
const data: PluginSecretResponse = await response.json();python
import requests
response = requests.post(
"https://<host>/api/v1/plugins/secrets",
headers={
"Authorization": "Bearer <token>",
"Content-Type": "application/json",
},
json={
"name": "string",
"plugin_id": "string",
"value": "string",
},
)
response.raise_for_status()
print(response.json())go
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
body := strings.NewReader(`{
"name": "string",
"plugin_id": "string",
"value": "string"
}`)
req, err := http.NewRequest(http.MethodPost, "https://<host>/api/v1/plugins/secrets", body)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer <token>")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
data, err := io.ReadAll(res.Body)
if err != nil {
panic(err)
}
fmt.Println(res.Status, string(data))
}java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Example {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://<host>/api/v1/plugins/secrets"))
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.method("POST", HttpRequest.BodyPublishers.ofString("""
{
"name": "string",
"plugin_id": "string",
"value": "string"
}
"""))
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode() + " " + response.body());
}
}csharp
using System.Net.Http.Headers;
using System.Text;
using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Post, "https://<host>/api/v1/plugins/secrets");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", "<token>");
request.Content = new StringContent("""
{
"name": "string",
"plugin_id": "string",
"value": "string"
}
""", Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);
Console.WriteLine($"{(int)response.StatusCode} {await response.Content.ReadAsStringAsync()}");php
<?php
$ch = curl_init('https://<host>/api/v1/plugins/secrets');
curl_setopt_array($ch, [
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer <token>',
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => <<<'JSON'
{
"name": "string",
"plugin_id": "string",
"value": "string"
}
JSON,
CURLOPT_RETURNTRANSFER => true,
]);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
echo $status . " " . $response . PHP_EOL;ruby
require "net/http"
uri = URI("https://<host>/api/v1/plugins/secrets")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = <<~'JSON'
{
"name": "string",
"plugin_id": "string",
"value": "string"
}
JSON
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
http.request(request)
end
puts "#{response.code} #{response.body}"rust
// Cargo.toml dependencies: reqwest (features "json"), serde_json, tokio (features "full")
use serde_json::json;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let response = reqwest::Client::new()
.post("https://<host>/api/v1/plugins/secrets")
.header("Authorization", "Bearer <token>")
.json(&json!({
"name": "string",
"plugin_id": "string",
"value": "string"
}))
.send()
.await?;
println!("{} {}", response.status(), response.text().await?);
Ok(())
}Authorizations
BearerAuth· API key in header "Authorization" — Type "Bearer" followed by a space and a sign-in token: a Guardian Platform JWT, or an OIDC ID token in a standalone deployment.
Request bodyrequired
Secret to store
application/json
namestringplugin_idstringvaluestring
Examplejson
{
"name": "string",
"plugin_id": "string",
"value": "string"
}Responses
200OK
application/json
correlation_idstringitemplugins.PluginSecretMetadataShow plugins.PluginSecretMetadata
created_atstringcreated_bystringidintegerkey_idstringnamestringplugin_idstringupdated_atstringupdated_bystringvalue_fingerprintstring
Examplejson
{
"correlation_id": "string",
"item": {
"created_at": "string",
"created_by": "string",
"id": 0,
"key_id": "string",
"name": "string",
"plugin_id": "string",
"updated_at": "string",
"updated_by": "string",
"value_fingerprint": "string"
}
}400Bad Request
application/json
codestringcorrelation_idstringmessagestring
Examplejson
{
"code": "string",
"correlation_id": "string",
"message": "string"
}401Unauthorized
application/json
codestringcorrelation_idstringmessagestring
Examplejson
{
"code": "string",
"correlation_id": "string",
"message": "string"
}403Forbidden
application/json
codestringcorrelation_idstringmessagestring
Examplejson
{
"code": "string",
"correlation_id": "string",
"message": "string"
}500Plugin secret encryption not configured
application/json
codestringcorrelation_idstringmessagestring
Examplejson
{
"code": "string",
"correlation_id": "string",
"message": "string"
}