Sign in

v1

latestOpenAPI 3.1.02026-08-0413468163.9 KB
v1-connectors

Delete Connector Endpoint

Delete connector and all associated resources.

Cleanup handled by the DBOS connector-delete workflow:

  • Branching engine infrastructure (replication pipeline, compute, slot)
  • Delayed stored credential purge after DB finalization
  • Database record

Args: force: When true, bypass the in-flight WAL/Kafka drain wait (ARD-870). Customer accepts that any un-replicated data is abandoned; the un-drained delta is recorded in cleanup_failures for operator triage.

delete/v1/connectors/{connector_id}

Path parameters

connector_idstring required

Query parameters

forceboolean

Response

Delete accepted (or already in progress). Poll GET /v1/operations/{operation_id}.

operation_idstring required

Operation to poll at GET /v1/operations/{operation_id}.

status'pending' | 'running' | 'completed' | 'failed' required

Lifecycle status of an async operation. Mirrors the async_operations_status_valid CHECK constraint.

type'connector_engine_setup' | 'connector_reset' | 'connector_deep_reset' | 'connector_discovery' | 'connector_delete' | 'connector_secret_purge' | 'connector_rollout' | 'connector_replication_rollback' | 'connector_debezium_cutover' | 'connector_debezium_shadow_cleanup' | 'environment_deploy' | 'environment_destroy' | 'branch_create' | 'branch_delete' required

Discriminator for an async operation. Must match the async_operations_type_valid CHECK constraint in the migration — extending the set requires a migration to widen the constraint AND a worker registered in the dispatcher.

resource_idstring nullable required

ID of the resource being created or acted on (the branch ID for branch create).