Warehouse
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
GET | |
POST | |
GET | |
PATCH | |
DELETE | |
POST | |
POST | |
POST | |
GET | |
POST | |
GET | |
PATCH | |
DELETE | |
POST | |
POST | |
POST |
List all environments warehouse tables
Create, Read, Update and Delete Warehouse Tables.
Required API key scopes
warehouse_table:readPath parameters
- environment_idstring
Query parameters
- limitinteger
- offsetinteger
- searchstring
Response
Example request
GET /api /environments /:environment_id /warehouse_tablesExample response
Status 200
Create environments warehouse tables
Create, Read, Update and Delete Warehouse Tables.
Required API key scopes
warehouse_table:writePath parameters
- environment_idstring
Request parameters
- deletedboolean
- namestring
- format
- url_patternstring
- credential
- optionsobject
Response
Example request
POST /api /environments /:environment_id /warehouse_tablesExample response
Status 201
Retrieve environments warehouse tables
Create, Read, Update and Delete Warehouse Tables.
Required API key scopes
warehouse_table:readPath parameters
- environment_idstring
- idstring
Response
Example request
GET /api /environments /:environment_id /warehouse_tables /:idExample response
Status 200
Update environments warehouse tables
Create, Read, Update and Delete Warehouse Tables.
Required API key scopes
warehouse_table:writePath parameters
- environment_idstring
- idstring
Request parameters
- deletedboolean
- namestring
- format
- url_patternstring
- credential
- optionsobject
Response
Example request
PATCH /api /environments /:environment_id /warehouse_tables /:idExample response
Status 200
Delete environments warehouse tables
Create, Read, Update and Delete Warehouse Tables.
Required API key scopes
warehouse_table:writePath parameters
- environment_idstring
- idstring
Example request
DELETE /api /environments /:environment_id /warehouse_tables /:idExample response
Status 204 No response body
Create environments warehouse tables refresh schema
Create, Read, Update and Delete Warehouse Tables.
Path parameters
- environment_idstring
- idstring
Request parameters
- deletedboolean
- namestring
- format
- url_patternstring
- credential
- optionsobject
Example request
POST /api /environments /:environment_id /warehouse_tables /:id /refresh_schemaExample response
Status 200 No response body
Create environments warehouse tables update schema
Create, Read, Update and Delete Warehouse Tables.
Path parameters
- environment_idstring
- idstring
Request parameters
- deletedboolean
- namestring
- format
- url_patternstring
- credential
- optionsobject
Example request
POST /api /environments /:environment_id /warehouse_tables /:id /update_schemaExample response
Status 200 No response body
Create environments warehouse tables file
Create, Read, Update and Delete Warehouse Tables.
Required API key scopes
warehouse_table:writePath parameters
- environment_idstring
Example request
Example response
Status 200 No response body
List all warehouse tables
Create, Read, Update and Delete Warehouse Tables.
Required API key scopes
warehouse_table:readPath parameters
- project_idstring
Query parameters
- limitinteger
- offsetinteger
- searchstring
Response
Example request
GET /api /projects /:project_id /warehouse_tablesExample response
Status 200
Create warehouse tables
Create, Read, Update and Delete Warehouse Tables.
Required API key scopes
warehouse_table:writePath parameters
- project_idstring
Request parameters
- deletedboolean
- namestring
- format
- url_patternstring
- credential
- optionsobject
Response
Example request
POST /api /projects /:project_id /warehouse_tablesExample response
Status 201
Retrieve warehouse tables
Create, Read, Update and Delete Warehouse Tables.
Required API key scopes
warehouse_table:readPath parameters
- idstring
- project_idstring
Response
Example request
GET /api /projects /:project_id /warehouse_tables /:idExample response
Status 200
Update warehouse tables
Create, Read, Update and Delete Warehouse Tables.
Required API key scopes
warehouse_table:writePath parameters
- idstring
- project_idstring
Request parameters
- deletedboolean
- namestring
- format
- url_patternstring
- credential
- optionsobject
Response
Example request
PATCH /api /projects /:project_id /warehouse_tables /:idExample response
Status 200
Delete warehouse tables
Create, Read, Update and Delete Warehouse Tables.
Required API key scopes
warehouse_table:writePath parameters
- idstring
- project_idstring
Example request
DELETE /api /projects /:project_id /warehouse_tables /:idExample response
Status 204 No response body
Create warehouse tables refresh schema
Create, Read, Update and Delete Warehouse Tables.
Path parameters
- idstring
- project_idstring
Request parameters
- deletedboolean
- namestring
- format
- url_patternstring
- credential
- optionsobject
Example request
POST /api /projects /:project_id /warehouse_tables /:id /refresh_schemaExample response
Status 200 No response body
Create warehouse tables update schema
Create, Read, Update and Delete Warehouse Tables.
Path parameters
- idstring
- project_idstring
Request parameters
- deletedboolean
- namestring
- format
- url_patternstring
- credential
- optionsobject
Example request
POST /api /projects /:project_id /warehouse_tables /:id /update_schemaExample response
Status 200 No response body
Create warehouse tables file
Create, Read, Update and Delete Warehouse Tables.
Required API key scopes
warehouse_table:writePath parameters
- project_idstring