Firebolt Query API

The Query API from Firebolt — 1 operation(s) for query.

OpenAPI Specification

firebolt-query-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Firebolt REST Firebolt REST API Query API
  description: Issue SQL queries against Firebolt engines and manage account/engine resources. Authentication is OAuth 2.0 client_credentials against https://id.app.firebolt.io/oauth/token (audience https://api.firebolt.io). The returned bearer token is used on subsequent requests against api.app.firebolt.io and individual engine URLs.
  version: '1.0'
  contact:
    name: Firebolt
    url: https://docs.firebolt.io/guides/run-queries/using-the-api
servers:
- url: https://api.app.firebolt.io
  description: Firebolt account / management API
- url: https://id.app.firebolt.io
  description: Firebolt identity / OAuth API
security:
- bearerAuth: []
tags:
- name: Query
paths:
  /query:
    post:
      summary: Query information_schema on the system engine
      operationId: queryInformationSchema
      requestBody:
        required: true
        content:
          text/plain:
            schema:
              type: string
              example: SELECT * FROM information_schema.engines
      responses:
        '200':
          description: Query result
          content:
            application/json:
              schema:
                type: object
      tags:
      - Query
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT