Skip to main content
Version: current

File

Use the Catalog API to retrieve information about files.

File Object
{
  "entityType": "file",
  "id": "dremio:/Samples/samples.dremio.com/SF weather 2018-2019.csv",
  "path": [
    "Samples",
    "samples.dremio.com",
    "SF weather 2018-2019.csv"
  ]
}

File Attributes​

{{< api-section file="data/software-api/file.json" data="fileAttributes" >}}

Retrieving a File by Path​

Retrieve information about a file by specifying its path.

Method and URL
GET /api/v3/catalog/by-path/{path}

Parameters​

{{< api-section file="data/software-api/file.json" data="retrieveFilePathParameters" >}}


Example Request
curl -X GET 'https://{hostname}/api/v3/catalog/by-path/Samples/samples.dremio.com/SF%20weather%2018-2019.csv' \
--header 'Authorization: _dremio{tokenstring}' \
--header 'Content-Type: application/json'
Example Response
{
  "entityType": "file",
  "id": "dremio:/Samples/samples.dremio.com/SF weather 2018-2019.csv",
  "path": [
    "Samples",
    "samples.dremio.com",
    "SF weather 2018-2019.csv"
  ]
}

Response Status Codes​

{{< api-responses file="data/software-api/file.json" data="retrieveFilePathResponseCodes" >}}