docs(ip_version): add missing parameter for 4 providers

- allinkl, name.com, netcup, nowdns, porkbun
This commit is contained in:
Quentin McGaw
2024-01-29 09:33:27 +00:00
parent fc500f7443
commit 67b83d402a
5 changed files with 26 additions and 5 deletions

View File

@@ -12,7 +12,8 @@
"domain": "domain.com",
"host": "host",
"username": "dynXXXXXXX",
"password": "password"
"password": "password",
"ip_version": "ipv4"
}
]
}
@@ -25,4 +26,8 @@
- `"username"` username (usually starts with dyn followed by numbers)
- `"password"` password in plain text
### Optional parameters
- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
## Domain setup

View File

@@ -14,7 +14,9 @@
"domain": "domain.com",
"host": "@",
"username": "username",
"token": "token"
"token": "token",
"ttl": 300,
"ip_version": "ipv4"
}
]
}

View File

@@ -17,7 +17,8 @@ Also keep in mind, that TTL, Expire, Retry and Refresh values of the given Domai
"host": "host",
"api_key": "xxxxx",
"password": "yyyyy",
"customer_number": "111111"
"customer_number": "111111",
"ip_version": "ipv4"
}
]
}
@@ -30,3 +31,7 @@ Also keep in mind, that TTL, Expire, Retry and Refresh values of the given Domai
- `"api_key"` is your api key (generated in the [customercontrolpanel](https://www.customercontrolpanel.de))
- `"password"` is your api password (generated in the [customercontrolpanel](https://www.customercontrolpanel.de)). Netcup only allows one ApiPassword. This is not the account password. This password is used for all api keys.
- `"customer_number"` is your customer number (viewable in the [customercontrolpanel](https://www.customercontrolpanel.de) next to your name). As seen in the example above, provide the number as string value.
### Optional parameters
- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.

View File

@@ -11,7 +11,8 @@
"provider": "nowdns",
"domain": "domain.com",
"username": "username",
"password": "password"
"password": "password",
"ip_version": "ipv4"
}
]
}
@@ -22,3 +23,7 @@
- `"domain"` your full domain name (FQDN)
- `"username"` your email address
- `"password"`
### Optional parameters
- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.

View File

@@ -19,7 +19,7 @@
}
```
### Parameters
### Compulsory Parameters
- `"domain"`
- `"host"` is your host and can be a subdomain, `"*"` or `"@"`
@@ -27,6 +27,10 @@
- `"secretapikey"`
- `"ttl"` optional integer value corresponding to a number of seconds
### Optional parameters
- `"ip_version"` can be `ipv4` (A records), or `ipv6` (AAAA records) or `ipv4 or ipv6` (update one of the two, depending on the public ip found). It defaults to `ipv4 or ipv6`.
## Domain setup
- Create an API key at [porkbun.com/account/api](https://porkbun.com/account/api)