IBM Cloud Classic (SoftLayer) DNS
SoftLayer API key setup: give a dedicated IBM Cloud user the Classic infrastructure Manage DNS permission, then create its Classic infrastructure API key.
On this page
SoftLayer API key permissions
- Credential type
- Classic infrastructure API key
- Preview access
- Classic infrastructure → Network → Manage DNS
- Apply access
- Classic infrastructure → Network → Manage DNS
- API endpoint
- DNSMigrator uses the provider's fixed API endpoint.
Additional access
DNSControl id
{
"TYPE": "SOFTLAYER"
}Create credentials
Give a dedicated IBM Cloud user the Classic infrastructure Manage DNS permission, then create its Classic infrastructure API key.
Access you'll grant
Classic infrastructure → Network → Manage DNS
Classic infrastructure → Network → Manage DNS
Before you start
- An IBM Cloud account with Classic infrastructure access.
- Each DNS domain must already exist in IBM Cloud Classic DNS; this adapter cannot create domains.
- An account owner or ancestor user allowed to manage the target user's Classic infrastructure permissions.
Setup steps
0 of 5 done
Create or select a dedicated user
In the IBM Cloud console, open Manage → Access (IAM) → Users and create or select the user that DNSMigrator will use.
Grant Manage DNS
Open the user's Classic infrastructure tab, select Permissions, expand Network, enable Manage DNS, and save. Do not assign a bulk Super user permission set just for DNS.
Required permissionManage DNSCreate a Classic infrastructure key
Open Manage → Access (IAM) → API keys, select Classic infrastructure API keys, and choose Create a classic infrastructure key. IBM allows one Classic infrastructure API key per user.
Copy the username and API key
Copy or download the key. To retrieve it later, use the key row's Actions → View details. Use the Classic infrastructure username shown there; in most accounts it is
<account_ID>_<email_address>and matches the VPN username on User details.Paste the Classic credentials
Paste the Classic infrastructure identity into Classic infrastructure username and the 64-character key into Classic infrastructure API key. Do not use an IBM Cloud IAM API key or the user's normal password.
Troubleshooting
IBM Cloud rejects the username or key
Confirm both values come from Classic infrastructure API keys. An IBM Cloud IAM API key and an email-only username do not match the Basic authentication this adapter uses.
IBM Cloud returns 403
Have an account owner or an ancestor in the Classic infrastructure user hierarchy enable Network → Manage DNS for this user.
A DNS domain does not appear
Add the domain in the IBM Cloud Classic DNS console first. DNSMigrator can update its records but cannot create the SoftLayer DNS domain.
Official documentation
Guide checked against the official documentation on .
Credential fields
| Field | Requirement | Where to find it |
|---|---|---|
| Classic infrastructure usernameusername | Required | The Classic infrastructure username from the key details or the VPN username on User details, often <account_ID>_<email_address>. |
| Classic infrastructure API keyapiKey | Required | The Classic infrastructure API key from Create a classic infrastructure key or Actions → View details; not an IBM Cloud IAM API key. |
Capabilities
- Create zones
- No
- List zones
- Yes
- DNSSEC
- Not available through this connection
- Minimum TTL
- 60 seconds
- Apex CNAME
- No
- Read only
- No
Record types
- A
- AAAA
- CNAME
- MX
- TXT
- NS
- SRV
- PTR
- SPF
Caveats
- Domains must already exist in the IBM Cloud classic DNS console. We can't create them.
- Only A, AAAA, CNAME, MX, NS, PTR, SPF, SRV and TXT records are supported, so CAA records can't be migrated here.
- The minimum TTL is 60 seconds, and the DNSControl provider for SoftLayer is unmaintained, so treat this integration with extra care.
Troubleshooting
- IBM Cloud rejects the username or key
- Confirm both values come from Classic infrastructure API keys. An IBM Cloud IAM API key and an email-only username do not match the Basic authentication this adapter uses.
- IBM Cloud returns 403
- Have an account owner or an ancestor in the Classic infrastructure user hierarchy enable Network → Manage DNS for this user.
- A DNS domain does not appear
- Add the domain in the IBM Cloud Classic DNS console first. DNSMigrator can update its records but cannot create the SoftLayer DNS domain.