Files

GET /files/{id}

Gets details of a file based on its ID.

Request

Base URL
https://api.cxxx.eagleeyenetworks.com/api/v3.0
URL
https://api.cxxx.eagleeyenetworks.com/api/v3.0/files/{id}
Auth
HTTP bearer

Query parameters

includestring[]

The fields you want included in the response. If not specified, the response includes a default set of fields specific to this method. You can use the special value * during development to return all fields, however, to achieve better performance, it is advisable to explicitly select only the fields you need.

[
  "accountId",
  "publicShare",
  "notes",
  "createTimestamp",
  "updateTimestamp",
  "size",
  "metadata",
  "tags",
  "childCount",
  "details"
]

Response

idstring uuid

The ID of the item.

directorystring

Name of the parent directory.

mimeType'video/mp4' | 'application/directory'

The media content type.

namestring

Name of the item.

Example response

{
  "id": "123e4567-e89b-12d3-a456-426655440000",
  "directory": "/Bundles/North Door",
  "mimeType": "video/mp4",
  "name": "Video North Door 2022-08-03 23-04-50.mp4"
}

Changes

No recorded changes to this operation across all 1 revision of this API.