Create DNS record | regfish DNS & TLS API

POST

/dns/rr

ResourceRecords

Authentifizierung

x-api-keyapplication/json

SchnellstartAuthentifizierung Regfish ConsoleAPI-Key im Regfish-Interface anlegen und testen

Request Body

application/jsonPflicht

Data object for the record

recordRequestFQDN

{
  "type": "A",
  "name": "api.example.com.",
  "data": "203.0.113.10",
  "ttl": 300
}

Felder

Name

Typ

Format

Pflicht

Description

type

A

string

—

Pflicht

—

name

string

—

Pflicht

Fully Qualified Domain Name (FQDN, ending with a period).

ttl

integer

—

Optional

Time To Live (60-604800)

annotation

string

—

Optional

A custom note for this particular record.

data

string

—

Pflicht

—

Request-Beispiel

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-Beispiel 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-Beispiel 400

{
  "success": false,
  "message": "Invalid request",
  "error": "Invalid request"
}

401

Unauthorized

application/jsonError

Response-Beispiel 401

{
  "success": false,
  "message": "Unauthorized",
  "error": "Unauthorized"
}

404

No matching DNS zone found

application/jsonError

Response-Beispiel 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-Beispiel 417

{
  "success": false,
  "message": "DNS record creation violates a zone constraint",
  "error": "DNS record creation violates a zone constraint"
}

500

Unexpected error

application/jsonError

Response-Beispiel 500

{
  "success": false,
  "message": "Unexpected error",
  "error": "Unexpected error"
}

Verwandte Modelle

Fully Qualified Domain Name (FQDN, ending with a period).

fqdn_or_subdomain

Fully Qualified Domain Name (FQDN) or subdomain. You can use the `@` symbol to represent your apex domain (e.g., example.com). Wildcards are supported.

recordResponseAdditionalReqFQDN

recordResponseAdditionalReqRRID

recordResponseAdditionalState

Time To Live (60-604800)

TXT

type

Authentifizierung

Request Body

Felder

Request-Beispiel

Responses

Werde ein Teil der Community