v1

latestOpenAPI 3.1.02026-08-0413468163.9 KB
v1-connectors

Engine Setup Endpoint

Dispatch a branching-engine setup as an async operation.

The actual provisioning (Neon project, pgstream, snapshot, RLS) runs 5–10 minutes — far past the ALB 60s idle timeout — so this endpoint returns 202 with an operation_id within ~1s. The CLI polls GET /v1/operations/{id} for stage transitions and the terminal outcome (ARD-741).

Fast paths preserved from the prior synchronous endpoint:

  • Already-healthy connector → 200 with the existing connector row.
  • Wrong starting status → 400 with the rejected status name.
  • Service has no engine-setup handler → 400. Anything past that point goes to the worker.

Requirements:

  • Connector must exist
  • branching_engine_status must be retryable for setup dispatch
post/v1/connectors/{connector_id}/engine-setup

Path parameters

connector_idstring required

Response

Nothing to do: the engine is already set up. Returns the connector row with a message.

idstring required

Connector ID.

org_idstring required

Organization the connector belongs to.

project_idstring nullable

Project the connector belongs to.

namestring required

Connector name.

service_namestring required

Service type. postgresql today.

statusstring nullable

Current connector status.

created_atstring nullable

When the connector was created.

can_updateboolean nullable

Whether the caller may update this connector.

can_deleteboolean nullable

Whether the caller may delete this connector.