Appearance
appdata.instance.restore ​
Restore a dump from this app's instance onto a different app instance in the same organization; the source stays up
Restore a named dump onto another app's instance in the same org.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-appdata |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | Authenticated organization UUID |
identity_app_uuid | uuid | Yes | — | Identity app the credential reads; must own an appdata namespace in this organization |
request_id | string | No | — | Caller request id for audit correlation |
actor | string | No | — | — |
target_identity_app_uuid | uuid | Yes | — | App whose instance receives the dump; must differ from identity_app_uuid |
backup_name | string | Yes | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | — |
identity_app_uuid | uuid | Yes | — | — |
backend_kind | string | No | — | — |
restored | boolean | No | — | — |
backup_name | string | No | — | — |
source_identity_app_uuid | uuid | No | — | — |
failure_reason | string | No | — | Engine-stamped failure reason |
failed_at_state | string | No | — | State when the workflow failed |
failed_step | string | No | — | Failed DAG step name |
failed_layer | integer | No | — | Failed DAG layer index |
error | string | No | — | Engine-stamped exception message |
error_type | string | No | — | Engine-stamped exception class name |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | complete | Restore credential |
completed | No | Yes | Yes | — | Credential restored |
failed | No | Yes | No | — | Restore failed |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | complete | completed | — |
pending | fail | failed | — |
Outcomes ​
| Outcome | Type | Description | State Data Keys |
|---|---|---|---|
restored | SUCCESS | Restore a dump from this app's instance onto a different app instance in the same organization; the source stays up | restored, backup_name |
failed | FAILURE | Appdata workflow failed | failure_reason |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "appdata.instance.restore",
"initial_data": {
"organization_uuid": "value",
"identity_app_uuid": "value",
"target_identity_app_uuid": "value",
"backup_name": "value"
}
}