Skip to main content
PATCH
Error

Authorizations

Authorization
string
header
required

API token obtained from the Tokens endpoint or CLI device login. Include as Authorization: Bearer <token>. Requests made with a managed CLI session also include X-Strix-Workspace: <organization_id> to pin a process to the workspace it started in; recovery endpoints report the current workspace after a concurrent switch.

Scopes

test_users:write

Path Parameters

domainId
string<uuid>
required
headerId
string<uuid>
required

Body

application/json
name
string

HTTP token. Host, Content-Length, hop-by-hop headers, and proxy authorization are not allowed.

Required string length: 1 - 128
Pattern: ^[!#$%&'*+.^_`|~0-9A-Za-z-]+$
value
string
write-only

Header value. Strix encrypts the value. Creation requires a nonempty value. An empty or omitted value keeps the saved value on update.

Maximum string length: 8192
notes
string | null
Maximum string length: 1000
scope_domain_ids
string<uuid>[]

Domains where this header applies. An empty array means all domains in the organization. Creation defaults to the home domain.

Maximum array length: 100

Response

Header updated. Value stays hidden.

id
string<uuid>
required
name
string
required
value_set
boolean
required

The saved value is hidden.

created_at
string<date-time>
required
updated_at
string<date-time>
required
scope_domain_ids
string<uuid>[]
required

Domains where this header applies. An empty array means all domains in the organization. Creation defaults to the home domain.

Maximum array length: 100
domain_id
string<uuid>
required

The home domain where the header was saved.

can_manage
boolean
required

Whether the caller can manage every domain in this header scope.

notes
string | null