Data
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
GET | |
POST | |
DELETE | |
POST | |
POST | |
GET | |
POST | |
POST | |
GET | |
GET | |
GET |
Retrieve data warehouse my hoglake credentials
Your own live hoglake OAuth credentials (never their secrets), the projects you can put in one, and where to use them.
Required API key scopes
warehouse_view:readResponse
Example request
GET /api /projects /:project_id /data_warehouse /my_hoglake_credentialsExample response
Status 200
Create data warehouse my hoglake credentials
Create an OAuth client credential owned by you and limited to the projects you name. Each token it gets carries your current access on each project. The secret is in this response only.
Required API key scopes
warehouse_view:writeRequest parameters
- namestring
- scope
- ttl_secondsinteger
- team_idsarray
Response
Example request
POST /api /projects /:project_id /data_warehouse /my_hoglake_credentialsExample response
Status 201
Delete data warehouse my hoglake credentials
Revoke your credential now: new tokens are refused and its S3 vends stop.
Required API key scopes
warehouse_view:writePath parameters
- credential_idstring
Response
Example request
DELETE /api /projects /:project_id /data_warehouse /my_hoglake_credentials /:credential_idExample response
Status 200
Create data warehouse my hoglake credentials rotate
Replace your credential's secret; the old one stops working. The new secret is in this response only.
Required API key scopes
warehouse_view:writePath parameters
- credential_idstring
Response
Example request
POST /api /projects /:project_id /data_warehouse /my_hoglake_credentials /:credential_id /rotateExample response
Status 200
Create data warehouse onboard team
Onboard this project onto the organization's existing managed warehouse.
Requires a schema name and records the project's membership in the Duckgres control plane. Restricted to organization admins.
Required API key scopes
warehouse_view:writeRequest parameters
- schema_namestring
Response
Example request
POST /api /projects /:project_id /data_warehouse /onboard-teamExample response
Status 200
Retrieve data warehouse property values
API endpoints for data warehouse aggregate statistics and operations.
Required API key scopes
query:readExample request
GET /api /projects /:project_id /data_warehouse /property_valuesExample response
Status 200 No response body
Create data warehouse provision
Start provisioning a managed warehouse for this organization (shared by all its teams).
Required API key scopes
warehouse_view:writeRequest parameters
- database_namestring
- schema_namestring
Response
Example request
POST /api /projects /:project_id /data_warehouse /provisionExample response
Status 202
Create data warehouse reset password
Reset the root password for the managed warehouse.
Required API key scopes
warehouse_view:writeResponse
Example request
POST /api /projects /:project_id /data_warehouse /reset-passwordExample response
Status 200
Retrieve data warehouse running activity
Returns currently running activities (jobs with status 'Running'). Supports pagination and cutoff time filtering.
Query parameters
- cutoff_daysintegerDefault:
30 - kindstringDefault:
allOne of:"all""import""model" - limitintegerDefault:
20 - offsetintegerDefault:
0
Response
Example request
GET /api /projects /:project_id /data_warehouse /running_activityExample response
Status 200
Status 500 The activity query failed.
Retrieve data warehouse total rows stats
Returns aggregated statistics for the data warehouse total rows processed within the current billing period. Used by the frontend data warehouse scene to display usage information.
Response
Example request
GET /api /projects /:project_id /data_warehouse /total_rows_statsExample response
Status 200
Status 500 Billing could not be reached.
Retrieve data warehouse warehouse status
Get the current provisioning status of the managed warehouse, with this project's onboarding state.
Response
Example request
GET /api /projects /:project_id /data_warehouse /warehouse_status




