Get Secured API Key Remaining Validity | Ruby API Client V1 (Deprecated)
This version of the Ruby API client has been deprecated in favor of the latest version of the Ruby API client.
About this method
Retrieve the remaining validity of a secured API key in seconds.
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.
Get the remaining validity on a secured API key:
1 $remainingValidity = SearchClient::getSecuredApiKeyRemainingValidity('YourSecuredAPIkey');
default: no default
Secured API Key to retrieve remaining validity for