Skip to main content
PUT
Set an application plain value (browser session)

Authorizations

ankra_session
string
cookie
required

Browser session. Mutations also require X-Ankra-CSRF.

Headers

authorization
string | null
x-ankra-organisation-id
string | null

Path Parameters

application_id
string
required
key
string
required

Query Parameters

environment_id
string<uuid>

A stored application environment of this application. Omit it for the shared default every environment inherits. A legacy cluster ID is not accepted here, and empty or repeated values are refused.

Body

application/json

One plain value. It is stored as text and returned by reads, so it must not be a credential.

value
string
required

1 to 8192 bytes, with no NUL character.

Minimum string length: 1
confirm_plain
boolean
default:false

Store the value even though its name or the value itself looks like a credential.

Response

The plain value after the write.

One plain key of an application as it resolves in the scope read. Unlike a secret, the value is returned.

key
string
required
value
string | null
required

The value. Null when the key is turned off here (status disabled) or has no value in reach here (status not_set).

source
enum<string> | null
required

shared: the shared default; environment: the environment's own value or turn-off. Null for status not_set.

Available options:
shared,
environment
status
enum<string>
required

set carries a value; disabled is the key turned off in this environment; not_set is a plain key of the application with no value in reach here.

Available options:
set,
disabled,
not_set
updated_at
string<date-time> | null
required

When the entry read was last written. Null for status not_set.

updated_by
ApplicationEnvValueActor · object | null
required

Who last wrote the entry read; null for status not_set or when no person is recorded.