Firebolt APIs

Firebolt is a complete redesign of the cloud data warehouse for the era of cloud and data lakes. Data warehousing with extreme speed & elasticity at scale.

Developer

APIs

SDKs

Integrations

Firebolt APIs

Account Request URL

Base Endpoint

Analytics API

Retrieve analytics data for a query execution.

GET

/v1/queries/{queryId}/analytics

queryId, session_id, group_by, max_results, min_results

Catalog API

List schemas and tables in a database.

GET

/v1/schemas/{schema-id}/tables

schema-id, table_name

Database API

Get the metadata of a database.

GET

/v1/databases/{database-id}

database-id

Database API

Create a new database.

POST

/v1/databases

name, description, retention_period, engine_version, location

Database API

Update the properties of a database.

PUT

/v1/databases/{database-id}

database-id, name, description, retention_period, engine_version, location

Engine API

Get the metadata of an engine version.

GET

/v1/engines/{engine-id}

engine-id

Engine API

List engine versions available in a region.

GET

/v1/regions/{region-id}/engines

region-id

Query API

Get the execution status of a query.

GET

/v1/queries/{queryId}

queryId

Query API

Get the results of a query.

GET

/v1/queries/{queryId}/results

queryId

Query API

Execute a query.

POST

/v1/queries

workspace_id, database_id, query, requested_retries, cache_ttl, query_tag, client_session_id, group_by, limit, workload_management_policy, statement_id

Query API

Cancel a running query.

DELETE

/v1/queries/{queryId}

queryId

Saved Query API

Get a saved query.

GET

/v1/saved_queries/{saved-query-id}

saved-query-id

Saved Query API

Delete a saved query.

DELETE

/v1/saved_queries/{saved-query-id}

saved-query-id

Saved Query API

Create a saved query.

POST

/v1/saved_queries

workspace_id, database_id, query, name, description

Saved Query API

Update a saved query.

PUT

/v1/saved_queries/{saved-query-id}

saved-query-id, name, description, query

Schema API

Get the metadata of a schema.

GET

/v1/schemas/{schema-id}

schema-id

Schema API

Create a new schema.

POST

/v1/schemas

name, description

Schema API

Update the properties of a schema.

PUT

/v1/schemas/{schema-id}

schema-id, name, description

Session API

Create a new session.

PUT

/v1/sessions

statement_id, group_by, limit, workload_management_policy, session_parameters, constants

Session API

Close and cleanup a session.

DELETE

/v1/sessions/{session-id}

session-id

Statement API

Get the metadata of a statement.

GET

/v1/statements/{statement-id}

statement-id

Statement API

Create a new statement.

PUT

/v1/statements

query, group_by, limit, workload_management_policy, session_parameters, constants, statement_parameters, database_id

Table API

Get the metadata of a table.

GET

/v1/schemas/{schema-id}/tables/{table-id}

schema-id, table-id

Table API

Upsert data in a table.

PUT

/v1/schemas/{schema-id}/tables/{table-id}/data

schema-id, table-id, commit_mode, fields, rows

Table API

Delete data in a table.

DELETE

/v1/schemas/{schema-id}/tables/{table-id}/data

schema-id, table-id, partition_column, partition_values

Table API

Create or update the schema of a table.

PUT

/v1/schemas/{schema-id}/tables/{table-id}/schema

schema-id, table-id, columns, primary_key

View API

Get the metadata of a view.

GET

/v1/schemas/{schema-id}/views/{view-id}

schema-id, view-id

View API

Create a new view.

POST

/v1/schemas/{schema-id}/views

schema-id, name, definition

View API

Update the definition of a view.

PUT

/v1/schemas/{schema-id}/views/{view-id}

schema-id, view-id, definition

Warehouse API

Get the metadata of a warehouse.

GET

/v1/warehouses/{warehouse-id}

warehouse-id

Warehouse API

Create a new warehouse.

POST

/v1/warehouses

name, description, location, initial_cluster_count, scale_factor, max_cluster_count, min_cluster_count, cluster_compute_type, cluster_disk_type, cluster_storage_size

Warehouse API

Update the properties of a warehouse.

PUT

/v1/warehouses/{warehouse-id}

warehouse-id, name, description, cluster_compute_type, cluster_disk_type, cluster_storage_size

Details

Provider

Firebolt

Country HQ

API Type

REST

Other Apps

Upskill for a better future

Want to start tracking API at scale?

Get updates about your favorite APIs and SDKs

We do our best to ensure that the data we release is complete, accurate, and useful. However, because we are not able to verify all the data, and because the processing required to make the data useful is complex, we cannot be held liable for omissions or inaccuracies.