List storage files
Request accessPurpose
Retrieve a list of files stored in a private data storage location, optionally filtered by file extension or path prefix.
Request data
HTTP method: GET
- Constants and parameters enclosed in curly brackets
{}must be replaced with their values. - See the following Path parameters and Query parameters sections with the required and optional parameters tables for these values.
URL format
get
URL format
https://api.tomtom.com/maps/orbis/platform/private-gateway/storages/{id}/filesURL example
get
URL example
https://api.tomtom.com/maps/orbis/platform/private-gateway/storages/f47ac10b-58cc-4372-a567-0e02b2c3d479/files?extension=.parquetcurl command example
get
curl command example
curl -X GET "https://api.tomtom.com/maps/orbis/platform/private-gateway/storages/f47ac10b-58cc-4372-a567-0e02b2c3d479/files?extension=.parquet" \ -H "tomtom-api-key: YOUR_API_KEY" \ -H "Authorization: Bearer YOUR_AUTH_TOKEN"Request headers
| Header | Required | Description |
|---|---|---|
tomtom-api-key | Yes | Your TomTom API key |
Authorization | Yes | Bearer token from Azure CLI |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | The unique identifier of the storage |
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
extension | string | No | Filter files by extension (e.g. .parquet, .csv). Leading dot is optional. When omitted, defaults to parquet. Pass an empty value (extension=) to return files of all types |
prefix | string | No | Filter files whose path starts with this value. Useful for checking whether a specific file exists. Maximum length: 1024 characters |
Response data
Response example
{ "files": [ { "path": "input/my_map_data.parquet", "size": 19119, "last_modified": "2026-07-29T12:00:00Z" }, { "path": "input/my_map_data.results.parquet", "size": 30798992, "last_modified": "2026-07-30T06:03:37Z" } ]}Response fields
| Field | Type | Description |
|---|---|---|
files | array | List of file objects matching the query. Empty array if no files match |
files[].path | string | Path of the file within the storage container |
files[].size | integer | File size in bytes |
files[].last_modified | string | ISO 8601 timestamp of the last modification date |
Error responses
| HTTP Status | Error | Cause | Solution |
|---|---|---|---|
| 400 | Bad Request | prefix exceeds 1024 characters or extension exceeds 32 characters | Check parameter lengths |
| 401 | Unauthorized | Invalid credentials | Refresh API key or token |
| 403 | Forbidden | Insufficient permissions | Check your access rights |
| 404 | Not Found | Storage not found | Verify storage ID |
| 500 | Internal Server Error | Server-side issue | Retry the request |