List customer domains | regfish DNS & TLS API

GET

/domains

Domains

Authentifizierung

x-api-key

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

Parameter

Name

Typ

Format

Pflicht

Description

filter

query

string

—

Optional

Comma-separated list of filters. Supported values are `cancelled` and `dnssec-inactive`.

page

query

integer

—

Optional

—

pageSize

query

integer

—

Optional

—

search

query

string

—

Optional

Case-insensitive partial match against the domain name, owner label, or primary nameserver.

sortBy

query

string

—

Optional

Sort by one of the public response fields listed in `domainListSortKey`.

sortOrder

query

string

—

Optional

—

Request-Beispiel

GET

curl --request GET \
  --url 'https://api.regfish.com/domains?filter=example&page=1&pageSize=100&search=example&sortBy=domain&sortOrder=asc' \
  --header 'x-api-key: YOUR_API_KEY'

Responses

200

Customer domain list

application/jsondomainListResponse

Response-Beispiel 200

{
  "success": true,
  "code": 0,
  "response": {
    "domains": [
      {
        "domain": "www.example.com",
        "sld": "example",
        "tld": "example",
        "favorite": true,
        "owner": "example",
        "primary_nameserver": "example",
        "dnssec_state": "active",
        "auto_renew": true,
        "cancelled": true,
        "registered_at": 1,
        "expires_at": 1
      }
    ],
    "total_items": 1,
    "total_pages": 1,
    "page": 1,
    "page_size": 1,
    "search": "example",
    "filters": [
      "cancelled"
    ],
    "sort_by": "domain",
    "sort_order": "asc"
  }
}

400

Invalid query parameters

application/jsonError

Response-Beispiel 400

{
  "success": false,
  "message": "Invalid query parameters",
  "error": "Invalid query parameters"
}

401

Unauthorized

application/jsonError

Response-Beispiel 401

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

500

Unexpected error

application/jsonError

Response-Beispiel 500

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

Verwandte Modelle

baseResult

dnssecDisplayState

High-level DNSSEC status.

Fully Qualified Domain Name.

sortOrder

Werde ein Teil der Community

Das DNS API von Regfish ist die perfekte Lösung für Entwickler, die ihre Domains und DNS-Zonen automatisieren möchten. Werde Teil der Community und profitiere von den Vorteilen der DNS-Automatisierung. Das DNS API steht jedem Regfish-Kunden kostenlos zur Verfügung.