API DocsRESTRemote file service

ListRemoteFiles

List remote files.

GET
/api/v1/remote-files

Query Parameters

pageSizeinteger

The maximum number of remote files to return. The service may return fewer than this value. If unspecified, at most 50 remote files will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. Optional.

Format: "int64"

pageTokenstring

A page token, received from a previous ListRemoteFiles call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListRemoteFiles must match the call that provided the page token. Optional.

filterstring

A Common Expression Language (CEL) filter string. Available fields to filter by are remote_file_id, entity_id, entity_type, and file_name. For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional.

organizationIdstring

This field is only required if your user belongs to multiple organizations.

curl -X GET "<API_URL>/api/v1/remote-files?pageSize=0&pageToken=string&filter=string&organizationId=string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "remoteFiles": [
    {
      "remoteFileId": "string",
      "organizationId": "string",
      "entityId": "string",
      "entityType": "ENTITY_TYPE_UNSPECIFIED",
      "fileName": "string",
      "fileMimeType": "string",
      "fileContentEncoding": "string",
      "storageKey": "string",
      "fileSize": "string",
      "description": "string",
      "videoMetadata": {
        "height": 0,
        "width": 0,
        "durationSeconds": 0.1,
        "timestamp": "2019-08-24T14:15:22Z"
      },
      "imageMetadata": {
        "height": 0,
        "width": 0
      },
      "audioMetadata": {
        "durationSeconds": 0.1,
        "timestamp": "2019-08-24T14:15:22Z"
      },
      "createdByUserId": "string",
      "modifiedByUserId": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "modifiedDate": "2019-08-24T14:15:22Z"
    }
  ],
  "nextPageToken": "string"
}

Previous

GetRemoteFileUrl GET

Next

UpdateRemoteFile PATCH