Dremio Cloud
Dremio Software
 
On this page

    List Catalogs

    This API lists all top-level catalog containers.

    To obtain more information about a specific container including the container’s children, use either GET /catalog/{id} or GET /catalog/by-path/{path}.

    Syntax

    Method and URL 
    GET /api/v3/catalog

    Response Output

    List catalogs response output 
    {
  "data": [
     CatalogEntitySummary,
     ...
  ]
}

    CatalogEntitySummary

    A summary representation of a catalog entity, used when entities are listed as children.

    CatalogEntitySummary 
    {
  "id": String [immutable, generated by Dremio],
  "path": [String] [immutable, generated by Dremio],
  "tag": String [immutable, generated by Dremio],
  "type": String [DATASET, CONTAINER, FILE],
  "datasetType": [VIRTUAL, PROMOTED, DIRECT] [immutable, optional],
  "containerType": [SPACE, SOURCE, FOLDER, HOME] [immutable, optional]
}
    Name Type Description
    id String Catalog Entity ID. Generated by Dremio, immutable.
    path [String] Catalog Entity path. Immutable.
    tag String Identifies the instance of the entity, changed each time it is modified. Generated by Dremio, immutable.
    type String The entity type, must be either DATASET, CONTAINER or FILE. Generated by Dremio, immutable.
    datasetType String The dataset type, must be either VIRTUAL, PROMOTED or DIRECT. Only present if type is dataset. Generated by Dremio, immutable.
    containerType String The container type, must be either SPACE, SOURCE, FOLDER or HOME. Only present if type is containerType. Generated by Dremio, immutable.

    Example: Get catalog

    In this example, information about all of the top-level catalog entities is requested.

    Curl

    Example request 
    curl -X GET \
  http://localhost:9047/api/v3/catalog \
	-H "Content-Type: application/json" \
	-H "Authorization: _dremiohs85l11k2mh0b10l51ett9fsca"

    Response

    Example response 
    {
  "data": [
    {
      "id": "63dcd828-6993-472a-b0ac-c75a102cb762",
      "path": [
        "@dremio"
      ],
      "tag": "0",
      "type": "CONTAINER",
      "containerType": "HOME"
    },
    {
      "id": "f8f51908-7db5-4809-8740-4fc7dd9e9d03",
      "path": [
        "testing"
      ],
      "tag": "0",
      "type": "CONTAINER",
      "containerType": "SPACE"
    },
    {
      "id": "dc7b0afa-5600-40d3-a07f-dd1b079813a4",
      "path": [
        "sandbox"
      ],
      "tag": "0",
      "type": "CONTAINER",
      "containerType": "SPACE"
    },
    {
      "id": "125f0eb6-5444-4ca9-be99-cdcb04ca07dc",
      "path": [
        "DEV Hive"
      ],
      "tag": "0",
      "type": "CONTAINER",
      "containerType": "SOURCE"
    },
    {
      "id": "39c23b82-6ff0-41dc-ba11-a00e3da39192",
      "path": [
        "PROD S3"
      ],
      "tag": "0",
      "type": "CONTAINER",
      "containerType": "SOURCE"
    }
  ]
}