POST api/GetAPIKey

POST implementation of GetAPIKey

Request Information

URI Parameters

None.

Body Parameters

GetAPIKeyRequest
NameDescriptionTypeAdditional information
CustomerKey

The private Customer Key you were provided for the APT.MobileAPI service. This key MUST be kept safe!

 string

None.
RevokeExistingKey

This option allows you to immediately revoke your existing APIKey. If set to false then the Existing APIKey will continue to work for a 7 day grace period

 boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "CustomerKey": "sample string 1",
  "RevokeExistingKey": true
}

Response Information

Resource Description

GetAPIKeyResponse
NameDescriptionTypeAdditional information
APIKey

A new active API Key for the APT.MobileAPI service

 string

None.
Expiry

The expiry time for the new API Key. Currently only applicable for Test/Demo Keys

 date

None.

Response Formats

application/json, text/json

Sample: 
{
  "APIKey": "sample string 1",
  "Expiry": "2026-02-04T02:57:51.8378813+00:00"
}