Check domain availability | regfish DNS & TLS API

GET

/domains/availability/{domain}

Domains

Authentication

x-api-key

Getting startedAuthentication Regfish ConsoleCreate an API key in the regfish console and test it

Parameters

Name

Type

Format

Required

Description

domain

path

string

Required

A domain name to check. Unlike `fqdn_relaxed` this also accepts internationalised names (e.g. `müller-shop.de`); they are converted to punycode and validated against the public suffix list server-side.

Request example

GET

curl --request GET \
  --url 'https://api.regfish.com/domains/availability/example.de' \
  --header 'x-api-key: YOUR_API_KEY'

Responses

200

Availability result

application/jsondomainAvailabilityResponse

Response example 200

{
  "success": true,
  "code": 0,
  "response": {
    "domain": "example",
    "sld": "example",
    "tld": "example",
    "available": true,
    "status": "available",
    "flags": [
      "example"
    ]
  }
}

400

Not a valid registrable domain name

application/jsonError

Response example 400

{
  "success": false,
  "message": "Not a valid registrable domain name",
  "error": "Not a valid registrable domain name"
}

401

Unauthorized

application/jsonError

Response example 401

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

429

Too many availability checks

application/jsonError

Response example 429

{
  "success": false,
  "message": "Too many availability checks",
  "error": "Too many availability checks"
}

500

Unexpected error

application/jsonError

Response example 500

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

502

Availability could not be determined

application/jsonError

Response example 502

{
  "success": false,
  "message": "Availability could not be determined",
  "error": "Availability could not be determined"
}

Devenez membre de la communauté

L'API DNS Regfish est une excellente solution pour les développeurs qui souhaitent automatiser les domaines et les zones DNS. Faites partie de la communauté et bénéficiez de l'automatisation DNS. L'API DNS est disponible gratuitement pour chaque client Regfish.