API Management
API Management allows you to request API access and manage your API credentials directly in NameBright. With API Management, you can request access, create API credentials, manage your IP whitelist, copy your API key, and open the API documentation from one place.
Where to find API Management
To access API Management in NameBright, go to:
My Account > API Management
Before you can use the API
Before API access is available, you may need to complete one or more requirements shown on the API Management page. These can include:
Accepting the API Access Terms & Conditions
Submitting an API access request
Request API access
If your account does not yet have API access:
Go to My Account > API Management
Review the requirements shown on the page
Accept the Terms & Conditions if prompted
Click Apply for Access
After you apply, your status may show as Request pending until access is approved.
Create API credentials
Once your account is eligible, you can create API credentials from the API Management page.
To create a new API key:
Click Create API Key
Enter a Client Name
Choose the access scope
Choose the permission level
Add one or more IPv4 addresses to the IP whitelist
Complete the setup flow
Permission levels
When creating or editing API credentials, you can choose a permission level based on the level of access needed.
Each permission level builds on the one before it:
Domain Level Access - This is the base permission level. It allows access to standard domain management actions such as updating nameservers, host records, privacy protection, auto-renew settings, renewing domains, and registering domains.
Transfer Approval - This includes everything in Domain Level Access, plus transfer-related permissions. In addition to standard domain management actions, it allows the user to approve inbound pushes, initiate pushes to another account, approve outbound transfers, and perform other transfer-related actions.
Full Access - This includes everything in Transfer Approval, plus access to all remaining supported API actions. This is the highest permission level and is intended for users who need complete API access across the allowed domains or categories.
Access scope options
When creating or editing API credentials, you can choose how broadly the credentials apply. Available access scope options include:
All Domains & Categories
Specific Domains
Specific Categories
If you choose specific domains, you can select up to 20 individual domains. If you need access to more than that, you should grant access by category instead.
Authorization Token Expiration
Each time you start a session with the API you must obtain a valid OAuth2 bearer token from the NameBright OAuth2 API. Tokens are valid for 30 minutes.
IP whitelist
You can restrict API access to approved IPv4 addresses.
Important notes:
Only whitelisted IP addresses can use the credentials
Limit of up to 10 IPv4 addresses
Rate Limiting
This API enforces a rate limit of 30 requests per 30-second period. Requests that exceed this limit will receive a 429 Too Many Requests response. Wait for the current period to elapse before retrying.
Copy your API key and client secret
After creating credentials, NameBright will display your:
Client ID
Client Secret
Important: Your client secret is shown only once and will not be shown again. Be sure to copy and store it securely before continuing.
Manage existing API credentials
From the API Management page, you can manage existing API credentials. Depending on the credential, available actions may include:
Copying the API key
Editing the API key
Updating the IP whitelist
Deleting the API key
Generating a new client secret
Edit an API key
To update an existing credential:
Go to My Account > API Management
Select the API key you want to update
Click Edit API Key
Update the client name, access scope, permissions, or IP whitelist
Save your changes
Delete an API key
To delete an API key you no longer need:
Go to My Account > API Management
Select the API key
Choose Delete API Key
Review the confirmation message
Confirm deletion
Deleting an API key will stop any applications using that key from functioning properly.
Generate a new client secret
If you generate a new client secret, any application using the previous secret will no longer function until it is updated with the new value.
After generating the new secret:
Copy it immediately
Store it securely
Update your application configuration right away
Important: The client secret will not be shown again after this step.
View API documentation
The API Management page includes a View Documentation option that routes you to the current API documentation.
Troubleshooting
I cannot create API credentials Make sure you have completed all required API access steps shown on the API Management page.
I did not save my client secret Client secrets are only shown once. If you did not save it, you will need to generate a new client secret.
My application stopped working Check whether the API key was deleted, the client secret was regenerated, or the IP address being used is not on the whitelist.
My API access request is still pending If your account shows Request pending, your access request has been submitted but has not yet been approved
