Get DNS record

GET

/dns/rr/{rrid}

ResourceRecordsByID

Authentication

x-api-key

Getting startedAuthentication Customer areaCreate an API key in the regfish console and test it

Parameters

Name

Type

Format

Required

Description

rrid

path

number

-

Required

Resource Record ID

Request example

GET

curl --request GET \
  --url 'https://api.regfish.com/dns/rr/1' \
  --header 'x-api-key: YOUR_API_KEY'

Responses

200

The record corresponding to the provided `rrid`

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

DNS record not found

application/jsonError

Response example 404

{
  "success": false,
  "message": "DNS record not found",
  "error": "DNS record not found"
}

500

Unexpected error

application/jsonError

Response example 500

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

Related models

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.

HINFOStored

A record of a type the API returns as stored but does not create or update (managed in the dash). `data` is the raw record data. Apex NS records are not part of the record list; see the nameserver endpoints.

A record of a type the API returns as stored but does not create or update (managed in the dash). `data` is the raw record data. Apex NS records are not part of the record list; see the nameserver endpoints.

NSStored

A record of a type the API returns as stored but does not create or update (managed in the dash). `data` is the raw record data. Apex NS records are not part of the record list; see the nameserver endpoints.

PTRStored

A record of a type the API returns as stored but does not create or update (managed in the dash). `data` is the raw record data. Apex NS records are not part of the record list; see the nameserver endpoints.

record

recordResponse

recordResponseAdditionalReqFQDN

recordResponseAdditionalReqRRID

recordResponseAdditionalState

recordStored

A record of a type the API returns as stored but does not create or update (managed in the dash). `data` is the raw record data. Apex NS records are not part of the record list; see the nameserver endpoints.

recordTypeStored

RPStored

A record of a type the API returns as stored but does not create or update (managed in the dash). `data` is the raw record data. Apex NS records are not part of the record list; see the nameserver endpoints.

Time To Live in seconds (60-86400)

TXT

type

Authentication

Parameters

Request example

Responses

Become part of the community