Get storage credentials
Request accessPurpose
Retrieve temporary credentials to access a private data storage location for uploading input files and downloading results.
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}/credentials?type=READ_WRITEURL example
get
URL example
https://api.tomtom.com/maps/orbis/platform/private-gateway/storages/storage-001/credentials?type=READ_WRITEcurl command example
get
curl command example
curl -X GET "https://api.tomtom.com/maps/orbis/platform/private-gateway/storages/storage-001/credentials?type=READ_WRITE" \ -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 | Yes | The unique identifier of the storage |
Query parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
type | string | Yes | Credential type. Use READ_WRITE for upload/download operations or READ for download |
Response data
The credentials endpoint returns a wrapped Vault token that must be unwrapped before use. The response body contains the wrapped token as a string.
Response example
{ "credentials": "hvs.CAESI...truncated...wrapped_token"}
## Using the credentialsOnce you receive the wrapped token, you must unwrap it to obtain the actual storage credentials to locally authorize to your storage. See the [Storage authentication](/global-entity-matcher/pdg-authentication) documentation for detailed instructions on unwrapping the token and using the credentials to access storage.
## 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 |