Skip to main content

Catalogs Preview

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": "test.user@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​

{{< api-section file="data/api/arctic-catalogs.json" data="catalogAttributes" >}}

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": "test.user@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​

{{< api-responses file="data/api/arctic-catalogs.json" data="listingAllCatalogsResponses" >}}

Adding a Catalog​

Add a catalog.

Adding a Catalog
POST /v0/arctic/catalogs

Parameters​

{{< api-section file="data/api/arctic-catalogs.json" data="addingCatalogsParameters" >}}

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": "test.user@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​

{{< api-responses file="data/api/arctic-catalogs.json" data="addingCatalogsResponses" >}}

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​

{{< api-section file="data/api/arctic-catalogs.json" data="retrievingCatalogsParameters" >}}

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": "test.user@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​

{{< api-responses file="data/api/arctic-catalogs.json" data="retrievingCatalogsResponses" >}}

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​

{{< api-section file="data/api/arctic-catalogs.json" data="deletingCatalogsParameters" >}}

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​

{{< api-responses file="data/api/arctic-catalogs.json" data="deletingCatalogsResponses" >}}