Skip to main content

Catalog

To retrieve and manage Open Catalog objects using a standard API, Dremio also supports the Iceberg REST Catalog API.

Catalog Object 
{
  "data": [
    {
      "id": "5c2f0383-540c-462d-816a-a8be8334efe5",
      "path": [
        "dremio-project"
      ],
      "tag": "9027fe00-d27e-4d02-96a8-e7705c934888",
      "type": "CONTAINER",
      "containerType": "SOURCE",
      "stats": {
        "datasetCount": 18,
        "datasetCountBounded": false
      },
      "createdAt": "2025-10-13T15:55:01.434Z",
      "sourceChangeState": "NONE",
      "permissions": [
        "READ_METADATA",
        "READ",
        "WRITE",
        "ALTER_REFLECTION",
        "SELECT",
        "ALTER",
        "VIEW_REFLECTION",
        "MODIFY",
        "MANAGE_GRANTS",
        "CREATE_TABLE",
        "DROP",
        "EXTERNAL_QUERY",
        "INSERT",
        "TRUNCATE",
        "DELETE",
        "UPDATE",
        "EXECUTE",
        "CREATE_SOURCE",
        "ALL"
      ]
    }
  ]
}

Catalog Attributes​

data Array of Object

List of container objects in the catalog of the project.

Attributes of Objects in the data Array​

id String (UUID)

UUID of a catalog object.

path Array of String

Path of the catalog object within Dremio, expressed as an array. Each Dremio project contains an Open Catalog object with the same name as the project.

Example:

[
  "dremio-project"
]

tag String (UUID)

UUID of the version of the catalog object. Dremio changes the tag whenever the catalog object changes and uses the tag to ensure that PUT requests apply to the most recent version of the catalog object.

type String

Type of the object. All objects in the catalog list are of type CONTAINER. CONTAINER objects also appear in other contexts.

containerType String

CONTAINER objects are references to other object types. The containerType indicates the type of referenced object. Valid values are:

Example: SOURCE

stats Object

Information about the number of datasets in the catalog object and whether the dataset count is bounded. Appears in the response only if the request URL includes the include query parameter using ?include=datasetCount.

Example:

{
  "datasetCount": 18,
  "datasetCountBounded": false
}

createdAt String

Timestamp when the object was created.

sourceChangeState String

The status of any changes to the current state. Valid values are NONE, CREATING, DELETING.

permissions Array of String

List of privileges that you have on the catalog object. Only appears in the response if the request URL includes the ?include=permissions query parameter. For more information, see Privileges.

Example:

[
  "READ_METADATA",
  "READ",
  "WRITE",
  "ALTER_REFLECTION",
  "SELECT",
  "ALTER",
  "VIEW_REFLECTION",
  "MODIFY",
  "MANAGE_GRANTS",
  "CREATE_TABLE",
  "DROP",
  "EXTERNAL_QUERY",
  "INSERT",
  "TRUNCATE",
  "DELETE",
  "UPDATE",
  "EXECUTE",
  "CREATE_SOURCE",
  "ALL"
]

Attributes of the stats Object​

datasetCount Integer

Number of datasets the catalog object contains.

datasetCountBounded Boolean

If the dataset count is bounded, the value is true. Otherwise, the value is false.

Retrieve a Catalog​

Method and URL 
GET /v0/projects/{project_id}/catalog

Parameters​

project_id Path   String (UUID)

include Query   String   Optional

Include a non-default attribute in the response. The available values are:

  • ?include=permissions: Include each catalog object's permissions array in the response.
  • ?include=datasetCount: Include the stats object in the response.

For more information, see the include query parameter.

Example: ?include=permissions

Example​

Request 
curl -X GET "https://api.dremio.cloud/v0/projects/$PROJECT_ID/catalog" \
-H "Authorization: Bearer $DREMIO_TOKEN" \
-H 'Content-Type: application/json'
Response 
{
  "data": [
    {
      "id": "5c2f0383-540c-462d-816a-a8be8334efe5",
      "path": [
        "dremio-project"
      ],
      "tag": "9027fe00-d27e-4d02-96a8-e7705c934888",
      "type": "CONTAINER",
      "containerType": "SOURCE",
      "createdAt": "2025-10-13T15:55:01.434Z",
      "sourceChangeState": "NONE"
    },
    {
      "id": "b7d1494f-217e-41a3-8c40-c8d904e61419",
      "path": [
        "Samples"
      ],
      "tag": "2d55eae8-e938-4a86-b204-fed55f38f0a6",
      "type": "CONTAINER",
      "containerType": "SOURCE",
      "createdAt": "2025-10-13T15:55:01.434Z",
      "sourceChangeState": "NONE"
    }
  ]
}

Response Status Codes​

200   OK

401   Unauthorized

403   Forbidden

404   Not Found