Your OpenSRS API key authenticates your reseller account when connecting to OpenSRS servers over the API or through third-party tools. IP access rules let you restrict which networks can use that key. This guide walks through generating an API key and adding IP rules from the Reseller Control Panel (RCP).
About the API key and IP access rules
The API key is a private key used together with your client code (scripts) to authenticate API requests and establish a secure socket for client/server communications. The IP access rules control which IP addresses or ranges (in CIDR notation) are permitted to connect using that key.
Warning: Generating a new API key immediately invalidates the previous key. Be ready to deploy the new key everywhere it is used before you generate it, or you will see service interruption.
Before you begin
- You need access to the OpenSRS Reseller Control Panel as the primary reseller user.
- Know the public IP address (or CIDR range) of every server or workstation that will call the API.
- You can have a maximum of five IP access rules. Plan accordingly and remove unused rules before adding new ones.
- CIDR prefixes from /25 to /32 are supported.
Step 1: View or generate your API key
- Log in to the Reseller Control Panel.
- Click Account settings in the top right.
- Click API settings to view the current API key for your reseller account.
- If you need a new key, click Generate new API key in the API key section.
Tip: Store the API key in a secrets manager (not a shared document) and rotate it whenever a team member with access leaves.
Step 2: Open the IP access rules section
- In API settings, scroll to the IP access rules section.
- Click Edit to enable changes.
Step 3: Add a new IP rule
- In the IP address field, enter the IP address.
- From the CIDR prefix drop-down, choose the range (/25 through /32).
- In the Type section, choose whether to Allow or Deny the specified range.
- Click Add.
Note: If you have already reached the five-rule maximum, remove an unused rule before adding a new one.
Next steps
- Test your connection. Make a simple API call from the allowed IP to confirm the key and rules work as expected.
- Configure event notifications. Set up email or API polling so your integration can react to asynchronous domain changes.
- If a call fails, troubleshoot. Review the API connection troubleshooting guide to check the key, IP rules, and port access.
Questions? Contact OpenSRS Support.
How helpful was this article?
Thanks for your feedback!
Do you still need help? If so please submit a request here.