Skip to content
Proud to collaborate with Microsoft for Startups

kv.key.resolve ​

Resolve an Orkestia KV key to a reference (value only on explicit reveal)

Resolve one Orkestia KV key to a provider reference (default) or its decoded value (only when reveal is true).

Inputs:

  • connection_uuid: Bound provider CloudConnection (required)
  • app: App slug (required)
  • environment: Environment scope (required)
  • namespace: Namespace (optional, defaults to app)
  • key: Logical key (required)
  • reveal: Return the decoded value (optional, default false)

Outputs:

  • reference: {provider_resource_id, version} — always
  • value: decoded value — ONLY when reveal=true (sensitive)

read_only. When reveal is false the value is never fetched into output.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-kv
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidYes—Bound provider CloudConnection.
appstringYes——
environmentstringYes——
namespacestringNo—Namespace (defaults to app).
keystringYes——
revealbooleanNoFalseReturn the decoded value (trusted internal callers only).

Output Schema ​

FieldTypeRequiredDefaultDescription
keystringNo——
tierstringNo——
appstringNo——
environmentstringNo——
namespacestringNo——
providerstringNo——
provider_resource_idstringNo——
version_idstringNo——
referencejsonNo—{provider_resource_id, version} — reference only.
revealedbooleanNo——
valuestringNo—Decoded value — present only when reveal=true.
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "kv.key.resolve",
  "initial_data": {
    "connection_uuid": "value",
    "app": "value",
    "environment": "value",
    "key": "value"
  }
}