Skip to content

MCP for AI agents30 toolsYour AI agent works with the rights you give it. Registering, transferring and cancelling stay in the customer area. If you give it the right, it can retrieve the transfer code of a domain: at most 3 retrievals per domain and day, and every retrieval is logged.

Read the MCP docs
DNS automation
v1.6.2
Download OpenAPI
YAMLJSON

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

x-api-keyapplication/json
Getting startedAuthenticationCustomer areaCreate an API key in the regfish console and test it

Request body

application/jsonRequired
Data object for the record
recordRequestFQDN
recordRequestFQDN
{
  "type": "A",
  "name": "api.example.com.",
  "data": "203.0.113.10",
  "ttl": 300
}

Fields

Name
Type
Format
Required
Description
type
A
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
application/jsonrecordResponse
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
application/jsonError
Response example 400
{
  "success": false,
  "message": "Invalid request",
  "error": "Invalid request"
}
401
Unauthorized
application/jsonError
Response example 401
{
  "success": false,
  "message": "Unauthorized",
  "error": "Unauthorized"
}
404
No matching DNS zone found
application/jsonError
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
application/jsonError
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.
application/jsonError
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
application/jsonError
Response example 500
{
  "success": false,
  "message": "Unexpected error",
  "error": "Unexpected error"
}
Community

Become part of the community

The regfish DNS API is a great solution for developers who want to automate domains and DNS zones. Become part of the community and benefit from DNS automation. The DNS API is available free of charge to every regfish customer.

More free features