TransIP
TransIP API token setup: enable the TransIP API and use a whitelisted key pair for ongoing access, or a short-lived access token for a one-off connection.
On this page
TransIP API token permissions
- Credential type
- Username and API private key, or access token
- Preview access
- Read-only access token, or a key pair that mints a short-lived read/write token
- Apply access
- Read/write access token, or the recommended key pair
- API endpoint
- DNSMigrator uses the provider's fixed API endpoint.
Additional access
DNSControl id
{
"TYPE": "TRANSIP"
}Create credentials
Enable the TransIP API and use a whitelisted key pair for ongoing access, or a short-lived access token for a one-off connection.
Access you'll grant
Read-only access token, or a key pair that mints a short-lived read/write token
Read/write access token, or the recommended key pair
Before you start
- A TransIP account containing the domains whose DNS you want to manage.
- The account API Status set to On.
- For the recommended key-pair flow, permission to add our egress IP to the account's API whitelist.
Setup steps
0 of 7 done
Open the API settings
In the TransIP control panel, select the profile icon → My account → API.
Enable the API
Change the slider beside Status to On.
Allow-list DNSMigrator
Under IP Whitelisting, enter our egress IP in IP address and select Add IP address. TransIP accepts IPv4, IPv6, and CIDR ranges.
Whitelisted IPour egress IPCreate a key pair
Under Key Pairs, add a recognizable Label, leave Whitelisted IP enabled, and create the pair. A whitelist entry can be shared by all key pairs that use whitelisting.
Copy the private key
Copy the complete private key from Key Pair successfully added, including its
BEGINandENDlines. TransIP shows it once.Paste the key-pair fields
Enter the account login in TransIP username, paste the full PEM block into API private key, and turn on Key only accepts whitelisted IPs because Whitelisted IP was enabled when the pair was created.
Use an access token only when it fits
As an alternative, create a token under Access Tokens and paste it into Access token (instead of a key pair). Turn on Read-only for a preview-only token; leave it off to apply. Manually created tokens expire after at most one month.
Troubleshooting
`ip-not-allowed`: the key only accepts whitelisted IPs
Add our egress IP under IP Whitelisting and ensure Key only accepts whitelisted IPs matches the key pair's Whitelisted IP setting.
`api-restricted`: API Status is off
Open My account → API and set Status to On.
The access token expired or cannot apply
Create a new token with Read-only off, or switch to a key pair so DNSMigrator can mint fresh 30-minute tokens.
The private key cannot be read
Paste the full PEM block exactly as TransIP displayed it, including every line break and both boundary lines.
Official documentation
Guide checked against the official documentation on .
Credential fields
| Field | Requirement | Where to find it |
|---|---|---|
| TransIP usernamelogin | Optional | The TransIP account login used with the key pair. It is not required when an access token is supplied. |
| API private keyprivateKey | Optional | The complete one-time PEM private key, including the BEGIN and END lines. |
| Key only accepts whitelisted IPswhitelistedOnly | Optional | Turn on when the key pair was created with TransIP's Whitelisted IP option; DNSMigrator then requests non-global tokens. |
| Access token (instead of a key pair)accessToken | Optional | A temporary JWT from Access Tokens. Use instead of the username and private key, not in addition to them. |
Capabilities
- Create zones
- No
- List zones
- Yes
- DNSSEC
- Managed in the provider console
- Minimum TTL
- 60 seconds
- Apex CNAME
- No
- Read only
- No
Record types
- A
- AAAA
- CNAME
- MX
- TXT
- NS
- SRV
- CAA
- ALIAS
- NAPTR
- SSHFP
- TLSA
Caveats
- Every change replaces the domain's full DNS entry list in one request; entries outside the plan are sent back unchanged.
- The API allows 1000 requests per 15 minutes per account, and access tokens expire after at most one month.
- TXT values with double quotes, backslashes, backticks or trailing spaces are rejected or altered by TransIP.
Troubleshooting
- `ip-not-allowed`: the key only accepts whitelisted IPs
- Add {egressIp} under **IP Whitelisting** and ensure **Key only accepts whitelisted IPs** matches the key pair's **Whitelisted IP** setting.
- `api-restricted`: API Status is off
- Open **My account** → **API** and set **Status** to **On**.
- The access token expired or cannot apply
- Create a new token with **Read-only** off, or switch to a key pair so DNSMigrator can mint fresh 30-minute tokens.
- The private key cannot be read
- Paste the full PEM block exactly as TransIP displayed it, including every line break and both boundary lines.