Get storage details

Purpose

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/pdg/storages/{storageId}

URL example

get
URL example
https://api.tomtom.com/maps/orbis/platform/pdg/storages/storage-001

curl command example

get
curl command example
1curl -X GET "https://api.tomtom.com/maps/orbis/platform/pdg/storages/storage-001" \
2 -H "tomtom-api-key: YOUR_API_KEY" \
3 -H "Authorization: Bearer YOUR_AUTH_TOKEN" \
4 -H "X-Version: 1"

Request headers

HeaderRequiredDescription
tomtom-api-keyYesYour TomTom API key
AuthorizationYesBearer token from Azure CLI
X-VersionYesAPI version (use 1)

Request parameters

ParameterTypeRequiredDescription
storageIdstringYesThe unique identifier of the storage

Response data

Response example

1{
2 "id": "storage-001",
3 "name": "Production Data",
4 "description": "Storage for production matching jobs",
5 "region": "eu-west",
6 "createdAt": "2026-01-15T09:00:00Z",
7 "modifiedAt": "2026-01-20T16:45:00Z",
8 "files": [
9 {
10 "name": "roads_data.parquet",
11 "size": 15728640,
12 "uploadedAt": "2026-01-20T10:00:00Z"
13 },
14 {
15 "name": "roads_data_matched.parquet",
16 "size": 16777216,
17 "uploadedAt": "2026-01-20T10:25:00Z"
18 }
19 ]
20}

Response fields

FieldTypeDescription
idstringUnique identifier for the storage
namestringHuman-readable name of the storage
descriptionstringOptional description of the storage
regionstringGeographic region where data is stored
createdAtstringISO 8601 timestamp of storage creation
modifiedAtstringISO 8601 timestamp of last modification
filesarrayList of files in the storage
files[].namestringName of the file
files[].sizenumberFile size in bytes
files[].uploadedAtstringISO 8601 timestamp of file upload

Error responses

HTTP StatusErrorCauseSolution
401UnauthorizedInvalid credentialsRefresh API key or token
403ForbiddenInsufficient permissionsCheck your access rights
404Not FoundStorage not foundVerify storage ID
500Internal Server ErrorServer-side issueRetry the request