Skip to main content

Catalog

The catalog API lets you manage and interact with the following entities/objects:

Listing All Catalog Entities

Returns a list of all the sources, datasets (tables and views), and folders contained in this project.

Listing All Catalog Entities
GET /v0/projects/{project-id}/catalog

Parameters

project-id Path   String (UUID)

Unique identifier of the project you want to list catalog entities for.

Example: 02d36975-73eb-47ed-9bb5-de73060380f6

Example Request
curl -X GET 'https://api.dremio.cloud/v0/projects/02d36975-73eb-47ed-9bb5-de73060380f6/catalog' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json'
Example Response
{
"data": [
{
"id": "63505c60-bc86-42aa-a622-24e5f22ce50b",
"path": [
"@test@dremio.com"
],
"tag": "fdbc007c-6994-41c7-a578-e7bd0150d319",
"type": "CONTAINER",
"containerType": "HOME",
"createdAt": "2021-05-21T20:37:43.676Z"
},
{
"id": "32ea6c29-74b8-4ed7-ab96-5371e31d606d",
"path": [
"Samples"
],
"tag": "2eba7399-8607-4aa1-b97b-e8131afff284",
"type": "CONTAINER",
"containerType": "SOURCE",
"createdAt": "2021-05-21T20:37:47.695Z"
},
{
"id": "864e1c48-25b6-4ddd-b764-1fb5295dbe69",
"path": [
"postgres-doc"
],
"tag": "ff6848c9-6dba-4c2e-896d-d774b983bfe3",
"type": "CONTAINER",
"containerType": "SOURCE",
"createdAt": "2021-05-23T10:41:19.507Z"
},
{
"id": "e2165e5a-da79-4ec3-898c-e471f6ce5ea0",
"path": [
"glue"
],
"tag": "0ab6580a-edec-4f18-9b8a-4dabbb70a51d",
"type": "CONTAINER",
"containerType": "SOURCE",
"createdAt": "2021-05-24T01:51:40.245Z"
},
{
"id": "82528486-71a0-4941-8397-881d830eb5b2",
"path": [
"s3"
],
"tag": "4f267811-8db4-4c5f-8efa-1c9fdfaa1150",
"type": "CONTAINER",
"containerType": "SOURCE",
"createdAt": "2021-05-24T01:52:06.335Z"
},
{
"id": "b3746e13-f687-412f-ab39-bb695d190d28",
"path": [
"ms-sql-doc"
],
"tag": "2e86e6ad-ab3f-4152-9ab6-59f66c4bc422",
"type": "CONTAINER",
"containerType": "SOURCE",
"createdAt": "2021-05-24T09:12:09.335Z"
},
{
"id": "fec12b0e-c133-4826-8469-19de131ad1af",
"path": [
"oracle-doc"
],
"tag": "81b12036-6dde-447b-b227-e004e1af500c",
"type": "CONTAINER",
"containerType": "SOURCE",
"createdAt": "2021-05-24T10:43:59.452Z"
}
]
}

Responses

200   OK

400   Bad Request

401   Unauthorized

404   Not Found

Retrieving a Catalog Entity By Path

Returns the object with the given path.

Retrieving a Catalog Entity By Path
GET /v0/projects/{project-id}/catalog/by-path/{path}

Parameters

project-id Path   String (UUID)

Unique identifier of the project you want to list catalog entities for.

Example: 02d36975-73eb-47ed-9bb5-de73060380f6


path Path   String

Path of the catalog object.

Example: MySource/MyFolder

Example Request
curl -X GET 'https://api.dremio.cloud/v0/projects/02d36975-73eb-47ed-9bb5-de73060380f6/catalog/by-path/MySource/MyFolder' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json'

The example request returns a folder because the specified path includes the name of the source and the folder MySource/MyFolder.

Example Response
    {
"id": "ffbe8c1d-1db7-48d1-9c58-f452838fedc0",
"path": [
"MySource",
"MyFolder"
],
"tag": "b79b70f4-d4a7-4fb5-bfbb-dc00b1b29801",
"type": "CONTAINER",
"containerType": "FOLDER"
}

Responses

200   OK

400   Bad Request

401   Unauthorized

404   Not Found