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/private-gateway/storages/{id}

URL example

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

curl command example

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

Request headers

HeaderRequiredDescription
tomtom-api-keyYesYour TomTom API key
AuthorizationYesBearer token from Azure CLI

Request parameters

ParameterTypeRequiredDescription
idstringYesThe unique identifier of the storage

Response data

Response example

1{
2 "id": "storage-001",
3 "url": "https://storage-001.blob.core.windows.net/default/",
4 "type": "AZURE_BLOB_STORAGE"
5}

Response fields

FieldTypeDescription
idstringUnique identifier for the storage
urlstringURL address of storage
typestringType of storage, supported values: AZURE_BLOB_STORAGE

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