DNS automation
v1.6.2
Create DNS record
Create a new DNS record and automatically detect the zone based on the
fqdn specified in the name parameter.POST
/dns/rr
ResourceRecords
Authentication
Request body
Data object for the record
recordRequestFQDNrecordRequestFQDN
{
"type": "A",
"name": "api.example.com.",
"data": "203.0.113.10",
"ttl": 300
}Fields
Name
Type
Format
Required
Description
type
string
-
Required
-
name
string
-
Required
Fully Qualified Domain Name (FQDN, ending with a period).
ttl
integer
-
Optional
Time To Live in seconds (60-86400)
annotation
string
-
Optional
A custom note for this particular record.
data
string
-
Required
-
Request example
POST
curl --request POST \
--url 'https://api.regfish.com/dns/rr' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'content-type: application/json' \
--data '{
"type": "A",
"name": "api.example.com.",
"data": "203.0.113.10",
"ttl": 300
}'Responses
200
The record created, with its new ID
Response example 200
{
"success": true,
"code": 0,
"response": {
"type": "A",
"name": "www.example.com.",
"data": "12.12.12.12",
"id": 1,
"auto": true,
"active": true,
"ts_created": 1,
"ts_updated": 1
}
}400
Invalid request
Response example 400
{
"success": false,
"message": "Invalid request",
"error": "Invalid request"
}401
Unauthorized
Response example 401
{
"success": false,
"message": "Unauthorized",
"error": "Unauthorized"
}404
No matching DNS zone found
Response example 404
{
"success": false,
"message": "No matching DNS zone found",
"error": "No matching DNS zone found"
}417
DNS record creation violates a zone constraint
Response example 417
{
"success": false,
"message": "DNS record creation violates a zone constraint",
"error": "DNS record creation violates a zone constraint"
}429
Rate limit for ACME platform credentials (scope `acme-dns-challenge`): calls per minute, and distinct customers per day. Ordinary customer keys never receive this status on this endpoint.
Response example 429
{
"success": false,
"message": "Rate limit for ACME platform credentials (scope `acme-dns-challenge`): calls per minute, and distinct customers per day. Ordinary customer keys never receive this status on this endpoint.",
"error": "Rate limit for ACME platform credentials (scope `acme-dns-challenge`): calls per minute, and distinct customers per day. Ordinary customer keys never receive this status on this endpoint."
}500
Unexpected error
Response example 500
{
"success": false,
"message": "Unexpected error",
"error": "Unexpected error"
}Community
Forma parte de la comunidad
La DNS API de regfish es una gran solución para desarrolladores que quieren automatizar dominios y zonas DNS. Súmese a la comunidad y aproveche las ventajas de la automatización DNS. La DNS API está disponible gratis para todos los clientes de regfish.