Koo Docs
View as Markdown

Variable

A scoped, encrypted-at-rest variable — metadata plus the value for a non-sensitive one; a sensitive value is revealed once via the reveal endpoint.

Attributes

VariableDto

A scoped, encrypted-at-rest variable — metadata plus the value for a non-sensitive one; a sensitive value is revealed once via the reveal endpoint.

idstringread-only

Unique identifier of the variable (read-only).

namestringrequired

Variable name — the injected environment-variable name: letters, digits and underscores, starting with a letter or underscore (1–128 chars). Unique within its scope. `KOO_VARIABLES_REVISION` is reserved.

scope"project" | "environment" | "service"read-only

Where the variable lives: a project, one environment, or a single service (service overrides environment overrides project).

scopeIdstringread-only

Id of the resource the variable is scoped to (project, environment, or service).

sensitivebooleanrequired

When true, the value is withheld from ordinary reads and returned only by the audited reveal endpoint.

valuestring

The value — present only for a non-sensitive variable; a sensitive value is withheld and must be revealed one at a time.

connectionobject

Present for a connection variable — the managed addon and key it injects.

aliasTargetstring

Present for an alias variable — the name of the variable it resolves to through the scope chain.

createdAtstring <date-time>read-only

When the variable was created.

updatedAtstring <date-time>read-only

When the variable was last changed.

The Variable object
json
{  "id": "var_01example0000000000000000x",  "name": "my-app",  "scope": "project",  "scopeId": "scope_01example0000000000000000x",  "sensitive": true,  "value": "example",  "connection": {    "service": "example",    "key": "example"  },  "aliasTarget": "example",  "createdAt": "2026-01-01T00:00:00.000Z",  "updatedAt": "2026-01-01T00:00:00.000Z"}