Firebolt Web API

The Web API from Firebolt — 1 operation(s) for web.

OpenAPI Specification

firebolt-web-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Firebolt REST Firebolt REST API Web 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: Web
paths:
  /web/v3/account/{account_name}/engineUrl:
    get:
      summary: Get system engine URL for an account
      operationId: getSystemEngineUrl
      parameters:
      - name: account_name
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: System engine URL payload
          content:
            application/json:
              schema:
                type: object
                properties:
                  engineUrl:
                    type: string
      tags:
      - Web
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT