Store a workspace secret

curl --request POST \
  --url https://api.agentsfleet.net/v1/workspaces/{workspace_id}/secrets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {},
  "name": "<string>"
}
'

import requests

url = "https://api.agentsfleet.net/v1/workspaces/{workspace_id}/secrets"

payload = {
    "data": {},
    "name": "<string>"
}
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({data: {}, name: '<string>'})
};

fetch('https://api.agentsfleet.net/v1/workspaces/{workspace_id}/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://api.agentsfleet.net/v1/workspaces/{workspace_id}/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([
    'data' => [
        
    ],
    'name' => '<string>'
  ]),
  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.agentsfleet.net/v1/workspaces/{workspace_id}/secrets"

	payload := strings.NewReader("{\n  \"data\": {},\n  \"name\": \"<string>\"\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.agentsfleet.net/v1/workspaces/{workspace_id}/secrets")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {},\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.agentsfleet.net/v1/workspaces/{workspace_id}/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  \"data\": {},\n  \"name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "name": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "resolved_by": "<string>",
  "user_message": "<string>"
}

Secrets

Store a workspace secret

Stores an encrypted JSON object. Secret values are never returned. data must be a non-empty object no larger than 4 KiB. Larger values return UZ-VAULT-002. Strings, arrays, scalars, and empty objects return UZ-VAULT-001. Creating claims a name that is free. A name already held in this workspace returns UZ-VAULT-005 and nothing is written. Replace the existing secret’s whole body with PUT on the item route instead. The database decides the winner, so two concurrent creates on one name resolve to one 201 and one 409.

POST

workspaces

{workspace_id}

secrets

Store a workspace secret

curl --request POST \
  --url https://api.agentsfleet.net/v1/workspaces/{workspace_id}/secrets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {},
  "name": "<string>"
}
'

import requests

url = "https://api.agentsfleet.net/v1/workspaces/{workspace_id}/secrets"

payload = {
    "data": {},
    "name": "<string>"
}
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({data: {}, name: '<string>'})
};

fetch('https://api.agentsfleet.net/v1/workspaces/{workspace_id}/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://api.agentsfleet.net/v1/workspaces/{workspace_id}/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([
    'data' => [
        
    ],
    'name' => '<string>'
  ]),
  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.agentsfleet.net/v1/workspaces/{workspace_id}/secrets"

	payload := strings.NewReader("{\n  \"data\": {},\n  \"name\": \"<string>\"\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.agentsfleet.net/v1/workspaces/{workspace_id}/secrets")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {},\n  \"name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.agentsfleet.net/v1/workspaces/{workspace_id}/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  \"data\": {},\n  \"name\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "name": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "resolved_by": "<string>",
  "user_message": "<string>"
}

{
  "detail": "<string>",
  "docs_uri": "<string>",
  "error_code": "<string>",
  "request_id": "<string>",
  "title": "<string>",
  "action_id": "<string>",
  "current_state": "<string>",
  "etag": "<string>",
  "gate_id": "<string>",
  "missing_secrets": [
    "<string>"
  ],
  "outcome": "<string>",
  "resolved_at": 123,
  "resolved_by": "<string>",
  "user_message": "<string>"
}

Authorizations

Authorization

string

header

required

Obtain a token via the CLI auth flow (POST /v1/auth/sessions) or GitHub OAuth

Path Parameters

workspace_id

string

required

UUIDv7 of the workspace.

Body

application/json

Stores one secret under a name you choose.

agentsfleet ignores fields it does not know, instead of refusing the request.

data

object

required

The object to seal. agentsfleet reads nothing inside it beyond its shape.

Send any well-formed JSON object.

name

string

required

The name a fleet interpolates as ${secrets.<name>.<field>}.

Response

Created

What a create and a replace both answer with.

One shape for both verbs because both say the same thing — which name now holds a secret — and the status code is what distinguishes them.

name

string

required

The name the secret is stored under.

Overview

Health

Authentication

API keys

Tenants

Tenant provider

Tenant balance

Tenant models

Fleet

Runner plane

Model Library

Workspaces

Workspace preferences

Secrets

Connectors

Approvals

Fleets

Fleet library

Fleet messages

Fleet memories

Fleet schedules

Fleet events

Integration grants

Webhooks

Admin

Store a workspace secret

Authorizations

Path Parameters

Body

Response