appdata.instance.backup

Dump the app's own Postgres instance (pg_dump -Fc on the host)

Take a logical dump of the app's own instance.

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	—	—

Output Schema

Field	Type	Required	Default	Description
organization_uuid	uuid	Yes	—	—
identity_app_uuid	uuid	Yes	—	—
backend_kind	string	Yes	—	—
backup_name	string	No	—	—
bytes	integer	No	—	—
encrypted	boolean	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	Backup credential
completed	No	Yes	Yes	—	Credential backupd
failed	No	Yes	No	—	Backup failed

State Diagram

Transitions

From	Action	To	Description
pending	complete	completed	—
pending	fail	failed	—

Outcomes

Outcome	Type	Description	State Data Keys
backed-up	SUCCESS	Dump the app's own Postgres instance (pg_dump -Fc on the host)	backup_name, bytes
failed	FAILURE	Appdata workflow failed	failure_reason

API Usage

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

{
  "workflow_type": "appdata.instance.backup",
  "initial_data": {
    "organization_uuid": "value",
    "identity_app_uuid": "value"
  }
}