Bridge Payments Docs

Appearance

Dry-run module install or upgrade plan (Admin)​

POST
/bridge-payment/admin/plugins/{module_id}/dry-run

Computes ordered component plan (install / upgrade / repair / skip / drift) from the manifest and current registry, without executing SQL.

Request body (JSON, optional fields with defaults):

  • target: core | selected | all (default core)
  • components: string[] — component ids when target is selected
  • runtime_scope: string (default flowless-core)
  • skip_existing: boolean (default true)
  • repair_missing: boolean (default false) — when true, checksum drift can be reconciled as repair
  • verify_checksum: boolean (default true)
  • verbose: boolean (default false)

Success: { data, user_context, meta } with data.dry_run: true, data.plan, data.resolved_order, data.sql_preview, etc.

Errors: 409 with code: MODULE_DEPENDENCY_ERROR if a dependency module is not installed in the scope.

Authorizations​

SessionAuth

Session ID from Flowless authentication

TypeAPI Key (header: X-Session-ID)

Parameters​

Path Parameters

module_id*
Typestring
Required
Pattern"^[a-z0-9][a-z0-9-]*$"

Request Body​

application/json
JSON
{
"target": "core",
"components": [
"string"
],
"runtime_scope": "flowless-core",
"skip_existing": true,
"repair_missing": false,
"verify_checksum": true,
"verbose": false
}

Responses​

Dry-run plan

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI