The Versus data warehouse — exports, inventory import, reverse-ETL, and shares. Auto-generated from the platform OpenAPI schema so it matches the running API.
REST API for this feature — 23 operations across 15 resource paths, auto-generated from the platform's live OpenAPI schema (drf-spectacular).
Base URL
https://<your-versus-host>/api· AuthAuthorization: Bearer <JWT>(fromPOST /api/auth/token/) · 📄 Download the OpenAPI spec for Postman/Insomnia/Swagger · see the API overview for pagination, filtering, and errors.
GET /api/warehouse/connections/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
search | query | no | string | A search term. |
Responses: 200 → PaginatedSnowflakeConnectionList
POST /api/warehouse/connections/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
Request body (application/json): SnowflakeConnectionRequest
Responses: 201 → SnowflakeConnection
GET /api/warehouse/connections/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string | A UUID string identifying this snowflake connection. |
Responses: 200 → SnowflakeConnection
PUT /api/warehouse/connections/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string | A UUID string identifying this snowflake connection. |
Request body (application/json): SnowflakeConnectionRequest
Responses: 200 → SnowflakeConnection
PATCH /api/warehouse/connections/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string | A UUID string identifying this snowflake connection. |
Request body (application/json): PatchedSnowflakeConnectionRequest
Responses: 200 → SnowflakeConnection
DELETE /api/warehouse/connections/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string | A UUID string identifying this snowflake connection. |
Responses: 204
POST /api/warehouse/connections/{id}/enrich/Enrichment write-back (§14): update allow-listed Device fields from a
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string | A UUID string identifying this snowflake connection. |
Request body (application/json): SnowflakeConnectionRequest
Responses: 200 → SnowflakeConnection
POST /api/warehouse/connections/{id}/named_query/Run a governed catalog query (reverse-ETL pushdown, §14).
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string | A UUID string identifying this snowflake connection. |
Request body (application/json): SnowflakeConnectionRequest
Responses: 200 → SnowflakeConnection
POST /api/warehouse/connections/{id}/provision/Create Snowflake objects idempotently (§9, §10). Body flags select what:
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string | A UUID string identifying this snowflake connection. |
Request body (application/json): SnowflakeConnectionRequest
Responses: 200 → SnowflakeConnection
GET /api/warehouse/connections/{id}/runs/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string | A UUID string identifying this snowflake connection. |
Responses: 200 → SnowflakeConnection
POST /api/warehouse/connections/{id}/sync/Trigger an incremental export. Body: {domain, dry_run?, load?}. Runs
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string | A UUID string identifying this snowflake connection. |
Request body (application/json): SnowflakeConnectionRequest
Responses: 200 → SnowflakeConnection
POST /api/warehouse/connections/{id}/test/Validate auth + reachability against Snowflake. Updates the connection's
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string | A UUID string identifying this snowflake connection. |
Request body (application/json): SnowflakeConnectionRequest
Responses: 200 → SnowflakeConnection
GET /api/warehouse/inventory-sources/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
search | query | no | string | A search term. |
Responses: 200 → PaginatedInventorySourceList
POST /api/warehouse/inventory-sources/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
Request body (application/json): InventorySourceRequest
Responses: 201 → InventorySource
GET /api/warehouse/inventory-sources/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string | A UUID string identifying this inventory source. |
Responses: 200 → InventorySource
PUT /api/warehouse/inventory-sources/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string | A UUID string identifying this inventory source. |
Request body (application/json): InventorySourceRequest
Responses: 200 → InventorySource
PATCH /api/warehouse/inventory-sources/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string | A UUID string identifying this inventory source. |
Request body (application/json): PatchedInventorySourceRequest
Responses: 200 → InventorySource
DELETE /api/warehouse/inventory-sources/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string | A UUID string identifying this inventory source. |
Responses: 204
POST /api/warehouse/inventory-sources/{id}/apply/Apply a previously-previewed plan (run id in body) — §14a.5. Writes
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string | A UUID string identifying this inventory source. |
Request body (application/json): InventorySourceRequest
Responses: 200 → InventorySource
POST /api/warehouse/inventory-sources/{id}/preview/Dry-run plan (create/update/conflict/retire/noop per source row) —
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string | A UUID string identifying this inventory source. |
Request body (application/json): InventorySourceRequest
Responses: 200 → InventorySource
GET /api/warehouse/inventory-sources/{id}/runs/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string | A UUID string identifying this inventory source. |
Responses: 200 → InventorySource
GET /api/warehouse/runs/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
ordering | query | no | string | Which field to use when ordering the results. |
page | query | no | integer | A page number within the paginated result set. |
page_size | query | no | integer | Number of results to return per page. |
search | query | no | string | A search term. |
Responses: 200 → PaginatedWarehouseSyncRunList
GET /api/warehouse/runs/{id}/Deploy-safe base for making an existing DRF ModelViewSet tenant-isolated
| Parameter | In | Required | Type | Description |
|---|---|---|---|---|
id | path | yes | string | A UUID string identifying this warehouse sync run. |
Responses: 200 → WarehouseSyncRun
Auto-generated from drf-spectacular OpenAPI. Endpoint descriptions come from viewset docstrings/serializers; enriching those improves this page on the next generation.