Skip to content
Omniglass Omniglass Omniglass

Update a secret's field values

PATCH
/secrets/{id}
 
curl --request PATCH \
  --url https://example.com/api/v1/secrets/example \
  --header 'Content-Type: application/json' \
  --data '{ "fields": { "additionalProperty": "example" } }'

Replaces the given field values on a secret, re-sealing secret fields. Only values change; name, type, and owner are fixed at creation. An omitted field keeps its value. Gated by secret:update, plus platform:update when the secret sits at the platform tier.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required

The secret’s id

string

The secret’s id

Request Body required

Section titled “Request Body required ”
Media type application/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
fields
required

The field values to replace; an omitted field keeps its value

object
key
additional properties
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
admin_sensitive
required

When true, only the admin tier may see or reveal this secret, regardless of placement

boolean
fields
required
Array<object> | null
object
name
required
string
secret
required

Whether the field is encrypted at rest and masked here

boolean
value
required
string
id
required
string
name
required
string
owner_id

The owning entity’s id, the canonical handle; absent for a global owner

string
owner_kind
required
string
owner_name
string
secret_type
required

The secret_type name

string
secret_type_id
required

The secret_type’s uuid, the stable form of secret_type

string
Example 
{
  "$schema": "/api/v1/schemas/SecretBody.json"
}

default

Section titled “default ”

Error

Media type application/problem+json
object
$schema

A URL to the JSON Schema for this object.

string format: uri
detail

A human-readable explanation specific to this occurrence of the problem.

string
errors

Optional list of individual error details

Array<object> | null
object
location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string
message

Error message text

string
value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri
status

HTTP status code

integer format: int64
title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string
type

A URI reference to human-readable documentation for the error.

string format: uri
default: about:blank
Example 
{
  "$schema": "/api/v1/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}