2021-07-07 23:43:10 +08:00
## Configuration
2022-05-09 02:41:33 +08:00
To use this provider, add an entry to `creds.json` with `TYPE` set to `TRANSIP`
along with your TransIP credentials.
2021-07-22 00:06:29 +08:00
2022-10-31 19:03:12 +08:00
### Key Pairs
You can login with your `AccountName` and a `PrivateKey` which can be generated in the [TransIP control panel ](https://www.transip.nl/cp/account/api/ ). The `PrivateKey` is a stringified version of the Private Key given by the API, see the example below, each newline is replaced by "\n".
2021-07-22 00:06:29 +08:00
2022-05-09 02:41:33 +08:00
Example:
2023-03-03 05:17:27 +08:00
{% code title="creds.json" %}
2022-02-18 01:22:31 +08:00
```json
2021-07-22 00:06:29 +08:00
{
2022-10-28 04:17:19 +08:00
"transip": {
2022-05-09 02:41:33 +08:00
"TYPE": "TRANSIP",
2023-03-03 04:48:11 +08:00
"AccountName": "your-account-name",
2021-07-22 00:06:29 +08:00
"PrivateKey": "-----BEGIN RSA PRIVATE KEY-----\nMIICXAIBAAKBgQCqGKukO1De7zhZj6+H0qtjTkVxwTCpvKe4eCZ0FPqri0cb2JZfXJ/DgYSF6vUp\nwmJG8wVQZKjeGcjDOL5UlsuusFncCzWBQ7RKNUSesmQRMSGkVb1/3j+skZ6UtW+5u09lHNsj6tQ5\n1s1SPrCBkedbNf0Tp0GbMJDyR4e9T04ZZwIDAQABAoGAFijko56+qGyN8M0RVyaRAXz++xTqHBLh\n3tx4VgMtrQ+WEgCjhoTwo23KMBAuJGSYnRmoBZM3lMfTKevIkAidPExvYCdm5dYq3XToLkkLv5L2\npIIVOFMDG+KESnAFV7l2c+cnzRMW0+b6f8mR1CJzZuxVLL6Q02fvLi55/mbSYxECQQDeAw6fiIQX\nGukBI4eMZZt4nscy2o12KyYner3VpoeE+Np2q+Z3pvAMd/aNzQ/W9WaI+NRfcxUJrmfPwIGm63il\nAkEAxCL5HQb2bQr4ByorcMWm/hEP2MZzROV73yF41hPsRC9m66KrheO9HPTJuo3/9s5p+sqGxOlF\nL0NDt4SkosjgGwJAFklyR1uZ/wPJjj611cdBcztlPdqoxssQGnh85BzCj/u3WqBpE2vjvyyvyI5k\nX6zk7S0ljKtt2jny2+00VsBerQJBAJGC1Mg5Oydo5NwD6BiROrPxGo2bpTbu/fhrT8ebHkTz2epl\nU9VQQSQzY1oZMVX8i1m5WUTLPz2yLJIBQVdXqhMCQBGoiuSoSjafUhV7i1cEGpb88h5NBYZzWXGZ\n37sJ5QsW+sJyoNde3xH8vdXhzU7eT82D6X/scw9RZz+/6rCJ4p0=\n-----END RSA PRIVATE KEY-----"
}
}
2022-02-18 01:22:31 +08:00
```
2023-03-03 05:17:27 +08:00
{% endcode %}
2021-07-22 00:06:29 +08:00
2022-10-31 19:03:12 +08:00
### Access tokens
Or you can choose to have an `AccessToken` as credential. These can be generated in the [TransIP control panel ](https://www.transip.nl/cp/account/api/ ) and have a limited lifetime
2021-07-22 00:06:29 +08:00
2023-03-03 05:17:27 +08:00
{% code title="creds.json" %}
2022-02-18 01:22:31 +08:00
```json
2021-07-07 23:43:10 +08:00
{
2022-05-09 02:41:33 +08:00
"transip": {
"TYPE": "TRANSIP",
2021-07-07 23:43:10 +08:00
"AccessToken": "your-transip-personal-access-token"
}
}
2022-02-18 01:22:31 +08:00
```
2023-03-03 05:17:27 +08:00
{% endcode %}
2021-07-22 00:06:29 +08:00
2021-07-07 23:43:10 +08:00
## Metadata
This provider does not recognize any special metadata fields unique to TransIP.
## Usage
2023-03-11 21:42:01 +08:00
An example configuration:
2021-07-07 23:43:10 +08:00
2023-03-11 21:42:01 +08:00
{% code title="dnsconfig.js" %}
2023-01-20 20:56:20 +08:00
```javascript
2023-05-22 01:31:35 +08:00
var REG_NONE = NewRegistrar("none");
2022-05-09 02:41:33 +08:00
var DSP_TRANSIP = NewDnsProvider("transip");
2021-07-07 23:43:10 +08:00
2023-05-22 01:31:35 +08:00
D("example.tld", REG_NONE, DnsProvider(DSP_TRANSIP),
2022-05-09 02:41:33 +08:00
A("test", "1.2.3.4")
2021-07-07 23:43:10 +08:00
);
2022-02-18 01:22:31 +08:00
```
2023-03-11 21:42:01 +08:00
{% endcode %}
2021-07-07 23:43:10 +08:00
## Activation
TransIP depends on a TransIP personal access token.
