Deploy Source Schema
POST/api/v1/sources/:name/deploy
Plan (dry_run=true) or deploy a source version's schema to ClickHouse.
Runs the v2 YAML -> DDL pipeline. In plan mode the CREATE TABLE (+ any standard views) and validation errors are returned for review WITHOUT touching ClickHouse. In deploy mode the DDL is applied: an absent table is created, and an existing one gains the columns it lacks and moves to the version's TTL, so a re-deploy changes only what differs. The engine and the type of an existing column are left as created. A schema that failed validation is never deployed. A source on the bus transport whose Kafka topics the broker did not create is not marked deployed either, and the call answers 502 naming each topic.
Request
Responses
- 200
- 401
- 403
- 422
- 502
- default
Successful Response
No valid session: the credentials are missing, invalid or expired, or the account behind them is disabled or blocked
Refused: the session lacks the action this route checks, or its account must replace an issued password first. A SCIM route answers a refused action in the RFC 7644 error envelope
Validation Error
A backing service refused the deploy: ClickHouse rejected the DDL, or the source rides the bus and the broker did not create its topics (code topics_not_created, naming each topic and the broker's error code)
Problem details (RFC 9457)