API keys API
Get latest
Use your existing secret key to get a new secret key.
The response contains the secret key you should use from now on. Usually this is your existing key. When your existing key is about to expire, this is your new secret key.
You should do this once per day.
To test your automatic secret key renewal code:
- Create two secret API keys using QuickStream Portal.
- Configure your application to use the first key.
- Confirm that your application automatically switches to the second key.
Request
GET /api-keys/latest
Use your Secret API key to access this resource.
Request body
None.
Response
If successful, this method returns the following in the response body.
Field | Format | Data |
---|---|---|
keyName |
string |
The API key name. Use for logging. |
key |
string |
The secret API key. |
expiryDate |
date-time |
The date and time the key will expire. |
API Key response example
{
"keyName": "FACILITYCODE_SEC...zrikj5x",
"key": "FACILITYCODE_SEC_dcm89ugjh5jbcjq5pdymhgimdj7gwwd7dddhty6arjrjftv8hymz8zr",
"expiryDate": "2022-01-02T03:48:40+00:00"
}
HTTP status codes
See HTTP Status Codes for more.
Status Code | Description | More information |
---|---|---|
200 |
OK | The request has succeeded. |
401 |
UNAUTHORIZED | The secret API key in the request is expired, or you have used your Publishable API key instead of your Secret API key. View more. |