Sign in
latestOpenAPI 3.0.02026-08-10221235717.8 KB

e21ad140ec3c

public
Value

Create a Shared Value for an Application

The Shared Value created will be available to all Environments in that Application.

If a Value is marked as a secret, it will be securely stored. It will not be possible to retrieve the value again through the API. The value of the secret can however be updated.

post/orgs/{orgId}/apps/{appId}/values

Path parameters

orgIdstring required

The Organization ID.

appIdstring required

The Application ID.

Request body

descriptionstring nullable required
is_secretboolean
keystring required
valuestring nullable

Response

Shared Value successfully created.

created_atstring date-time required
descriptionstring required

A Human friendly description of what the Shared Value is.

is_secretboolean required

Specified that the Shared Value contains a secret.

keystring required

The unique key by which the Shared Value can be referenced. pattern: ^[a-zA-Z0-9._-]+$.

secret_keystring nullable required

Location of the secret value in the secret store.

secret_store_idstring nullable required
secret_versionstring nullable required

Version of the current secret value as returned by the secret store.

source'app' | 'env' required

Source of the value, "app" for app level, "env" for app env level.

updated_atstring date-time required
valuestring required

The value that will be stored. (Will be always empty for secrets.)

Example response

{
  "description": "The message to show me.",
  "is_secret": false,
  "key": "MY_MSG",
  "value": "Hello World"
}