Dremio | Intelligent Lakehouse Platform Catalog API

The Catalog API from Dremio | Intelligent Lakehouse Platform — 3 operation(s) for catalog.

Documentation GitHub OpenAPI

Operations 4

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /catalog Browse the top-level catalog · Retrieve the catalog for the current Dremio instance #

Ask an LLM

“What spaces, sources and home folders are at the top level of my catalog?”

“Can I see everything at the root of the catalog in one call?”

Tell an agent

Show me the top-level catalog of this instance.

List the root catalog and include {include}.

GET /catalog/{id} Look up a catalog item by its ID · Get a catalog entity by ID #

Ask an LLM

“How do I fetch the details of a dataset or folder when I only have its ID?”

“What does the catalog store about an entity, given its ID?”

Tell an agent

Get catalog entity {id}.

Show me the details of the catalog object with ID {id}.

DELETE /catalog/{id} Delete a catalog item · Delete a catalog entity #

Ask an LLM

“How do I remove a dataset, folder or space from the catalog?”

“Is deleting a catalog entity by ID permanent?”

Tell an agent destructive · confirm first

Delete catalog entity {id}.

Remove the catalog object with ID {id} from the lakehouse.

GET /catalog/by-path/{path} Look up a catalog item by its path · Get a catalog entity by path #

Ask an LLM

“How do I find a dataset by its dotted path instead of its ID?”

“Can I look up a folder or table using its full catalog path?”

Tell an agent

Get the catalog entity at path {path}.

Find the dataset located at {path} in the catalog and show its ID.

Specifications

⚙

OpenAPI

https://raw.githubusercontent.com/api-evangelist/dremio-intelligent-lakehouse-platform/refs/heads/main/openapi/dremio-intelligent-lakehouse-platform-catalog-api-openapi.yml

Other Resources

🔗

Overlay

https://raw.githubusercontent.com/api-evangelist/dremio-intelligent-lakehouse-platform/refs/heads/main/overlays/dremio-intelligent-lakehouse-platform-catalog-api-overlay.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/dremio-intelligent-lakehouse-platform:dremio-intelligent-lakehouse-platform-catalog-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Dremio Intelligent Lakehouse REST Catalog API
  version: 3.0.0
  description: Best-effort OpenAPI for Dremio's v3 REST API covering the catalog, jobs, reflections, sources, scripts, personal access tokens, and roles. Auth uses a bearer access token (OAuth or Personal Access Token).
  contact:
    name: API Evangelist
    email: kin@apievangelist.com
    url: https://docs.dremio.com/
servers:
- url: https://{hostname}/api/v3
  description: A Dremio server (self-hosted; substitute your hostname)
  variables:
    hostname:
      default: dremio.example.com
security:
- bearerAuth: []
tags:
- name: Catalog
paths:
  /catalog:
    get:
      tags:
      - Catalog
      summary: Retrieve the catalog for the current Dremio instance
      operationId: listCatalog
      parameters:
      - name: include
        in: query
        schema:
          type: string
          enum:
          - permissions
          - datasetCount
      responses:
        '200':
          description: Catalog entries
  /catalog/{id}:
    parameters:
    - $ref: '#/components/parameters/CatalogId'
    get:
      tags:
      - Catalog
      summary: Get a catalog entity by ID
      operationId: getCatalogEntity
      responses:
        '200':
          description: Catalog entity
    delete:
      tags:
      - Catalog
      summary: Delete a catalog entity
      operationId: deleteCatalogEntity
      responses:
        '204':
          description: Deleted
  /catalog/by-path/{path}:
    parameters:
    - name: path
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Catalog
      summary: Get a catalog entity by path
      operationId: getCatalogByPath
      responses:
        '200':
          description: Catalog entity
components:
  parameters:
    CatalogId:
      name: id
      in: path
      required: true
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: OAuth access token or Personal Access Token