API Keys are valid for one year from the date of creation. During this time, the API Key can be disabled, reactivated, regenerated or deleted using the Actions options. If you don't see the "API Access Key" portion on the User Control (URC) page, please click here for more information.
To view the API Key status
- By default, the API Key status will be Active with the slider on the right side (On).
To disable the API Key
- By toggling the slider to the left (Off), the API Key will be disabled.
- A pop-up message will be displayed, requesting you to confirm disabling of the API Key.
- By selecting the “Disable” button, the status will be updated as Disabled.
- By selecting the “Cancel” button, the pop-up will be closed.
To reactivate the API Key
- You can activate a disabled API Key with the Disable / Activate slider. You can toggle the slider to the right (On).
- A pop-up message will be displayed, requesting you to confirm the API Key activation.
- By selecting the “Activate” button, the status will be updated as Active.
- Once the API Key has been activated, you can perform normal functions unless Multi-Factor Authentication (MFA) has been disabled for any reason on your account.
- By selecting the “Cancel” button, the pop-up will be closed.
To regenerate the API Key
- An API Key can be regenerated to eliminate the old one and create a new API Key and Access Secret. If you need to generate a new API Key, please click here.
- By selecting the “Regenerate” icon, the API Key will be regenerated.
- A pop-up message will be displayed, requesting you to confirm the API Key regeneration.
- By selecting the “Get New Key” button, a new Access Key and Access Secret Key are generated.
- By selecting the “Cancel” button, the pop-up will be closed.
To delete the API Key
- By selecting the “Delete” icon, the API Key will be deleted at any time.
- A pop-up message will be displayed, requesting you to confirm the API Key deletion.
- By selecting the “Delete” button, the API Key will be deleted.
- After an API Key has been deleted, the URC page will be reset to show the “Generate New Key” button.
- By selecting the “Cancel” button, the pop-up will be closed.
Disclaimer: Any images in this article are intended to be used as a guide for educational purposes only and they may differ slightly from the Production Environment.