Skip to main content

Catalogs

An Arctic catalog lists all the tables and views that are in the data lake along with their locations. This API allows you to add, list, retrieve, and delete catalogs.

Catalog Object
{
  "id": "c683b988-aa93-439c-a9ac-0d7f72b53d23",
  "name": "sample-catalog",
  "ownerId": "37b34779-13f1-48e5-b2c8-f3db4c824733",
  "ownerName": "example@dremio.com",
  "createdBy": "de8a47bf-432a-4d83-b60e-90d86cda8d70",
  "modifiedBy": "de8a47bf-432a-4d83-b60e-90d86cda8d70",
  "createdAt": "2022-08-03T05:52:45.119Z",
  "modifiedAt": "2022-08-03T05:52:45.119Z"
}

Catalog Attributes​

id

String

The unique ID of the catalog. This ID is unique within a Dremio organization.

Example c683b988-aa93-439c-a9ac-0d7f72b53d23

name

String

User defined name for a catalog. Catalog names must be unique within a Dremio organization. Additionally, catalog names cannot be edited once the catalog is created.

Example sample-catalog

ownerId

String

The unique ID of the owner of the catalog.

Example 37b34779-13f1-48e5-b2c8-f3db4c824733

ownerName

String

The email address of the owner of the catalog.

Example owner

createdBy

String

The unique ID of the creator of the catalog. You can identify the creator from the ID by using the users system table.

For more information, read users system table.

Example de8a47bf-432a-4d83-b60e-90d86cda8d70

modifiedBy

String

The unique ID of the last person that modified the catalog. You can identify that person from the ID by using the users system table.

For more information, read users system table.

Example de8a47bf-432a-4d83-b60e-90d86cda8d70

createdAt

String

The date and time when the catalog was created.

Example 2022-08-03T05:52:45.119Z

modifiedAt

String

The date and time when the catalog was last modified.

Example 2022-08-03T05:52:45.119Z

Listing All Catalogs​

Returns a list of all the Arctic catalogs that have been created in an organization.

Listing All Catalogs
GET /v0/arctic/catalogs
Example Request
curl -X GET 'https://api.dremio.cloud/v0/arctic/catalogs' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json'
Example Response
[
  {
    "data": [
      {
        "id": "c683b988-aa93-439c-a9ac-0d7f72b53d23",
        "name": "myCatalog",    
        "ownerId": "37b34779-13f1-48e5-b2c8-f3db4c824733",
        "ownerName": "example@dremio.com",
        "createdBy": "de8a47bf-432a-4d83-b60e-90d86cda8d70",
        "modifiedBy": "de8a47bf-432a-4d83-b60e-90d86cda8d70",
        "createdAt": "2022-08-03T05:52:45.119Z",
        "modifiedAt": "2022-08-03T05:52:45.119Z"
      }
    ],
    "nextPageToken": null,
    "previousPageToken": null,
    "totalResults": "1"
  }
]

Responses​

200

OK

400

The request is invalid.

401

Unable to authenticate using the provided credentials.

403

The user executing the request lacks the required privileges.

Adding a Catalog​

Add a catalog.

Adding a Catalog
POST /v0/arctic/catalogs

Parameters​

name

body

String

User defined name for the catalog.

Note: Catalog names must be unique within a Dremio organization. Additionally, catalog names cannot be edited once the catalog is created.

requestId

body

String (UUID)

Optional

User-defined idempotency key, which is a unique value generated by the user that the server uses to register consequent retries of the same request. Generate the request ID by using a UUID generator tool.

For more information, read idempotent requests.

Example Request
curl -X POST 'https://api.dremio.cloud/v0/arctic/catalogs' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json' \
-d '{
      "name": "myCatalog",
      "requestId": "2eeff1aa-1bfb-4cf6-825b-5dd9022ac1d4"
    }'
Example Response
{
    "id": "c683b988-aa93-439c-a9ac-0d7f72b53d23",
    "name": "myCatalog",
    "ownerId": "37b34779-13f1-48e5-b2c8-f3db4c824733",
    "ownerName": "example@dremio.com",
    "createdBy": "de8a47bf-432a-4d83-b60e-90d86cda8d70",
    "modifiedBy": "de8a47bf-432a-4d83-b60e-90d86cda8d70",
    "createdAt": "2022-08-03T05:52:45.119Z",
    "modifiedAt": "2022-08-03T05:52:45.119Z"
  }

Responses​

200

OK

400

The request is invalid.

401

Unable to authenticate using the provided credentials.

403

The user executing the request lacks the required privileges.

Retrieving a Catalog​

Retrieve a catalog by providing the unique catalog ID that was returned on creation of the catalog.

Retrieiving a Catalog
GET /v0/arctic/catalogs/{id}

Parameters​

id

path

String

The ID of the catalog that you want to retrieve.

Example Request
curl -X GET 'https://api.dremio.cloud/v0/arctic/catalogs/05e2d620-5978-4269-8c96-aa463df830b7' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json'
Example Response
{
  "id": "05e2d620-5978-4269-8c96-aa463df830b7",
  "name": "myCatalog",
  "ownerId": "37b34779-13f1-48e5-b2c8-f3db4c824733",
  "ownerName": "example@dremio.com",
  "createdBy": "de8a47bf-432a-4d83-b60e-90d86cda8d70",
  "modifiedBy": "de8a47bf-432a-4d83-b60e-90d86cda8d70",
  "createdAt": "2022-08-03T05:52:45.119Z",
  "modifiedAt": "2022-08-03T05:52:45.119Z"
}

Responses​

200

OK

400

The request is invalid.

401

Unable to authenticate using the provided credentials.

403

The user executing the request lacks the required privileges.

Deleting a Catalog​

Delete the catalog by providing the catalog ID that was returned on creation of the project.

Deleting a Catalog
DELETE /v0/arctic/catalogs/{id}

Parameters​

id

path

String

The ID of the catalog that you want to delete.

Example Request
curl -X DELETE 'https://api.dremio.cloud/v0/arctic/catalogs/05e2d620-5978-4269-8c96-aa463df830b7' \
-H 'Authorization: Bearer <personal access token>' \
-H 'Content-Type: application/json'
Example Response
No response

Responses​

204

No message returned for this API function.

400

The request is invalid.

401

Unable to authenticate using the provided credentials.

403

The user executing the request lacks the required privileges.

404

The specified resource was not found.