Get storage details
Request accessPurpose
Retrieve detailed information about a specific private data storage location.
Request data
HTTP method: GET
- Constants and parameters enclosed in curly brackets
{}must be replaced with their values. - See the following Request parameters section 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/{storageId}URL example
get
URL example
https://api.tomtom.com/maps/orbis/platform/private-gateway/storages/storage-001curl command example
get
curl command example
curl -X GET "https://api.tomtom.com/maps/orbis/platform/private-gateway/storages/storage-001" \ -H "tomtom-api-key: YOUR_API_KEY" \ -H "Authorization: Bearer YOUR_AUTH_TOKEN" \ -H "X-Version: 1"Request headers
| Header | Required | Description |
|---|---|---|
tomtom-api-key | Yes | Your TomTom API key |
Authorization | Yes | Bearer token from Azure CLI |
X-Version | Yes | API version (use 1) |
Request parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
storageId | string | Yes | The unique identifier of the storage |
Response data
Response example
{ "id": "storage-001", "name": "Production Data", "description": "Storage for production matching jobs", "region": "eu-west", "createdAt": "2026-01-15T09:00:00Z", "modifiedAt": "2026-01-20T16:45:00Z", "files": [ { "name": "roads_data.parquet", "size": 15728640, "uploadedAt": "2026-01-20T10:00:00Z" }, { "name": "roads_data_matched.parquet", "size": 16777216, "uploadedAt": "2026-01-20T10:25:00Z" } ]}Response fields
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier for the storage |
name | string | Human-readable name of the storage |
description | string | Optional description of the storage |
region | string | Geographic region where data is stored |
createdAt | string | ISO 8601 timestamp of storage creation |
modifiedAt | string | ISO 8601 timestamp of last modification |
files | array | List of files in the storage |
files[].name | string | Name of the file |
files[].size | number | File size in bytes |
files[].uploadedAt | string | ISO 8601 timestamp of file upload |
Error responses
| HTTP Status | Error | Cause | Solution |
|---|---|---|---|
| 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 |