Regenerate Admin Key

Service version: 1
Last edit: 2022.08.31

Purpose

This endpoint is used to regenerate an Admin Key using a previous secret value. Should an existing Admin Key become compromised, lost, or just needs to be changed for any reason, a new Admin Key can be generated using this endpoint. At the same time, when a new Admin Key is regenerated the previous one gets revoked.

Request Data

HTTPS method: POST

  • Constants and parameters enclosed in curly brackets { } must be replaced with their values.
  • Please see the following Request parameters section with the required and optional parameters tables for their values. The generic request format is as follows.

URL request format

post
URL request format
https://{baseURL}/locationHistory/{versionNumber}/regenerateKey?key={Your_API_Key}

curl command request format

post
curl command request format
1curl -XPOST "Content-type: application/json" -d
2'{
3 "secret": "secret_key";
4 };'
5'https://{baseURL}/locationHistory/{versionNumber}/regenerateKey?key={Your_API_Key}'

POST request body format

post
POST request body format
1{
2 "secret": "secret_key"
3}

Request parameters

The following table describes the parameters that can be used in a request.

  • Required parameters must be used or the call will fail.
  • Optional parameters may be used.
  • The order of request parameters is not important.

Note: There are no optional parameters in this endpoint.

Required parameters

Description

baseURL


string

The base URL for calling the API.


Value: api.tomtom.com

versionNumber


string

Service version number.


Value: 1

key


string

An API Key valid for the requested service.


Value: Your valid API Key.

Response data

Response body

Response body format
1{
2 "adminKey": "<string>"
3}

Response fields

The following data tables describe all of the fields that can appear in a response.

Primary fields

Description

adminKey


string

A generated Admin Key that can be used to manage location history objects.

Response codes

Code

Meaning and possible causes

200

OK: Configuration registered. Admin Key regenerated.

400

Bad request: Missing or invalid request data.

401

Unauthorized: Provided secret is invalid.

Example

Regenerate an Admin Key using a passed secret value.

Request URL example

post
Request to regenerate an Admin Key - JSON example
https://api.tomtom.com/locationHistory/1/regenerateKey?key={Your_API_Key}

POST body example

post
HTTPS POST method example - JSON
1{
2 "secret" "Secret value"
3}

Response body example

The following JSON code block demonstrates a successful response from the API server.

Successful response - JSON
1{
2 "adminKey: UpP9m2jg4PU6fWAFnvskU33CwfW24e17P0oTC5byUfUzMElS&quot;
3}