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 ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-kv |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
connection_uuid | uuid | Yes | — | Bound provider CloudConnection. |
app | string | Yes | — | — |
environment | string | Yes | — | — |
namespace | string | No | — | Namespace (defaults to app). |
key | string | Yes | — | — |
reveal | boolean | No | False | Return the decoded value (trusted internal callers only). |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
key | string | No | — | — |
tier | string | No | — | — |
app | string | No | — | — |
environment | string | No | — | — |
namespace | string | No | — | — |
provider | string | No | — | — |
provider_resource_id | string | No | — | — |
version_id | string | No | — | — |
reference | json | No | — | {provider_resource_id, version} — reference only. |
revealed | boolean | No | — | — |
value | string | No | — | Decoded value — present only when reveal=true. |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
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"
}
}