API Reference / API Methods / API keys / Get secured API key remaining validity

Get Secured API Key Remaining Validity

Required API Key: Any secured API key
Method signature
SearchClient::getSecuredApiKeyRemainingValidity(apiKey)

About this method

You are currently reading the documentation of the JavaScript API Client v4. Read our migration guide to learn how to upgrade from v3 to v4. You can still access the v3 documentation.

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.

Examples

Get the remaining validity on a secured API key:

1
$remainingValidity = SearchClient::getSecuredApiKeyRemainingValidity('YourSecuredAPIkey');

Parameters

apiKey
type: string
default: no default
Required

Secured API Key to retrieve remaining validity for

Response

No response

Did you find this page helpful?