public
Value

Update Shared Value for an Application

Update the value or description of the Shared Value. Shared Values marked as secret can also be updated.

patch/orgs/{orgId}/apps/{appId}/values/{key}

Request

  • Base URL
    https://api.humanitec.io
  • URL
    https://api.humanitec.io/orgs/{orgId}/apps/{appId}/values/{key}
  • Auth
    none declared

Path parameters

orgIdstring required

The Organization ID.

appIdstring required

The Application ID.

keystring required

The key to update.

Request body

descriptionstring nullable
valuestring nullable

Response

Shared Value successfully updated.

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"
}

Changes

No recorded changes to this operation across all 9 revisions of this API.