Update Vault Description

curl --request PATCH \
  --url https://api.agents.slng.ai/v1/agents/secrets/{name}/description \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Primary Stripe API key"
}
'

import requests

url = "https://api.agents.slng.ai/v1/agents/secrets/{name}/description"

payload = { "description": "Primary Stripe API key" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({description: 'Primary Stripe API key'})
};

fetch('https://api.agents.slng.ai/v1/agents/secrets/{name}/description', 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.agents.slng.ai/v1/agents/secrets/{name}/description",
  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([
    'description' => 'Primary Stripe API 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://api.agents.slng.ai/v1/agents/secrets/{name}/description"

	payload := strings.NewReader("{\n  \"description\": \"Primary Stripe API key\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.agents.slng.ai/v1/agents/secrets/{name}/description")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"Primary Stripe API key\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.agents.slng.ai/v1/agents/secrets/{name}/description")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"Primary Stripe API key\"\n}"

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

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "organisation_id": "9c1e5b2a-1111-4c3d-8e2f-abcdef012345",
  "name": "STRIPE_KEY",
  "kind": "secret",
  "description": "Primary Stripe API key",
  "value": null,
  "has_value": true,
  "is_managed": false,
  "revision": 2,
  "created_by": "user:alice",
  "last_rotated_by": "user:bob",
  "last_rotated_at": "2026-08-20T12:00:00Z",
  "created_at": "2026-08-01T09:00:00Z",
  "updated_at": "2026-08-20T12:00:00Z"
}

PATCH

agents

secrets

{name}

description

Update Vault Description

curl --request PATCH \
  --url https://api.agents.slng.ai/v1/agents/secrets/{name}/description \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Primary Stripe API key"
}
'

import requests

url = "https://api.agents.slng.ai/v1/agents/secrets/{name}/description"

payload = { "description": "Primary Stripe API key" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({description: 'Primary Stripe API key'})
};

fetch('https://api.agents.slng.ai/v1/agents/secrets/{name}/description', 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.agents.slng.ai/v1/agents/secrets/{name}/description",
  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([
    'description' => 'Primary Stripe API 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://api.agents.slng.ai/v1/agents/secrets/{name}/description"

	payload := strings.NewReader("{\n  \"description\": \"Primary Stripe API key\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.agents.slng.ai/v1/agents/secrets/{name}/description")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"Primary Stripe API key\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.agents.slng.ai/v1/agents/secrets/{name}/description")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"Primary Stripe API key\"\n}"

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

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "organisation_id": "9c1e5b2a-1111-4c3d-8e2f-abcdef012345",
  "name": "STRIPE_KEY",
  "kind": "secret",
  "description": "Primary Stripe API key",
  "value": null,
  "has_value": true,
  "is_managed": false,
  "revision": 2,
  "created_by": "user:alice",
  "last_rotated_by": "user:bob",
  "last_rotated_at": "2026-08-20T12:00:00Z",
  "created_at": "2026-08-01T09:00:00Z",
  "updated_at": "2026-08-20T12:00:00Z"
}

Authorizations

Authorization

string

header

required

Your SLNG consumer API key.

Path Parameters

name

string

required

Unique name of the Vault entry whose description you are updating.

Body

application/json

The new description for the entry, or null to clear it.

Request body for updating only the description of a Vault entry. An empty or whitespace-only value clears the description.

description

string | null

New description for the entry. Provide null or an empty string to clear it.

Maximum string length: 500

Response

The Vault entry with its updated description. The stored value is unchanged.

List and detail view of a Vault entry. Secret values are never returned; variable values are returned to authorized readers in value (null for secrets).

string<uuid>

required

organisation_id

string<uuid>

required

name

string

required

kind

enum<string>

required

Kind of this entry: secret values are never returned, variable values are readable by authorized callers.

Available options:

secret,

variable

revision

integer

required

created_at

string<date-time>

required

updated_at

string<date-time>

required

description

string | null

value

string | null

The stored value, returned only for variables to authorized readers. Always null for secrets, whose value is never returned.

has_value

boolean

default:true

Whether a value is stored. True even for secrets, whose value is withheld from responses.

is_managed

boolean

default:false

Whether this entry is managed by SLNG rather than created directly by your organisation.

created_by

string | null

last_rotated_by

string | null

last_rotated_at

string<date-time> | null

⌘I

Overview

Unified API

Text-to-Speech

Speech-to-Text

Managed Agents

Agent resources

Batch

Account

Bridges

Update Vault Description

Authorizations

Path Parameters

Body

Response