Skip to main content
This page documents an earlier version of the API client. For the latest version, see Retrieve remaining validity for secured API key.
Required ACL: Any secured API key This method takes a secured API key as a parameter and returns the amount of seconds left until the API key’s validUntil field expires. If the key is no longer valid, the method returns a negative number indicating the amount of seconds passed since the key expired. If the API key has no validUntil restriction, this method raises an exception or an error depending on your client.

​
Examples

var remainingValidity = client.GetSecuredApiKeyRemainingValidity("YourSecuredAPIkey");

​
Parameters

​
apiKey
string
required
Secured API key to check.

​
Response

​
remaining
integer
The number of seconds left until the API key expires. If the key is no longer valid, the method returns a negative number indicating the amount of seconds passed since the key expired.If the API key has no validUntil restriction, this method raises an exception or an error depending on the API client.

​
Response as JSON

This section shows the JSON response returned by the API. Each API client wraps this response in language-specific objects, so the structure may vary. To view the response, use the getLogs method. Don’t rely on the order of properties—JSON objects don’t preserve key order.
JSON
15
⌘I