Skip to content
Proud to collaborate with Microsoft for Startups

kv.store.apply ​

Reconcile a declared Orkestia KV store on the bound provider

Reconcile an Orkestia KV store to a declared key set on the bound provider.

Inputs:

  • connection_uuid: Bound provider CloudConnection (required)
  • app: App slug (required)
  • environment: Environment scope (required)
  • namespace: Namespace (optional, defaults to app)
  • vault: Default tier is secret when true (optional)
  • keys: [{key, tier?, value?, ttl_seconds?}] (required)
  • prune: Delete provider keys not in the declaration (optional)

Outputs (references only, no values):

  • applied_count, rotated_count, pruned_count, keys

Fans out kv.key.set semantics per changed key; never spreads values.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-kv
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidYes—Bound provider CloudConnection.
appstringYes——
environmentstringYes——
namespacestringNo—Namespace (defaults to app).
vaultbooleanNo—Default tier is secret when true.
keyslistYes—[{key, tier?, value?(sensitive), ttl_seconds?}].
prunebooleanNo—Delete provider keys not in the declaration.

Output Schema ​

FieldTypeRequiredDefaultDescription
appstringNo——
environmentstringNo——
namespacestringNo——
providerstringNo——
applied_countintegerNo——
rotated_countintegerNo——
pruned_countintegerNo——
keysjsonNo—per-key {key, tier, version_id, provider_resource_id} — references only.
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.store.apply",
  "initial_data": {
    "connection_uuid": "value",
    "app": "value",
    "environment": "value",
    "keys": "value"
  }
}