DNS API-Referenz

v1.6.2

Change nameserver delegation (vanity sets only)

Delegates the domain to one of the account's vanity nameserver sets (vanity_set_id), or reverts it to the regfish standard nameservers (vanity_set_id: null). Free-form nameservers are intentionally NOT supported on this endpoint, externally hosted delegations must be managed in the regfish dash. Guarded by the Domain-Guardian (ns_change rule class), domain status checks (pending transfer, cancellation) and two daily change limits: 5 changes per domain and 50 changes per account, both counted across all of your API keys and OAuth clients. Issuing another credential does not raise either limit.

PUT

/domains/{domain}/nameservers

Domains

Authentifizierung

x-api-keyapplication/json

SchnellstartAuthentifizierung KundenbereichAPI-Schlüssel im Kundenbereich anlegen und testen

Parameter

Name

Typ

Format

Pflicht

Description

domain

path

string

Pflicht

Fully Qualified Domain Name.

Request Body

application/jsonPflicht

Keine Beschreibung in der Spezifikation vorhanden.

nameserversUpdateRequest

{
  "vanity_set_id": 1
}

Felder

Name

Typ

Format

Pflicht

Description

vanity_set_id

integer

Pflicht

Id of one of the account's vanity nameserver sets, or `null` to revert to the regfish standard nameservers. Free-form nameservers are not supported on this endpoint.

Request-Beispiel

PUT

curl --request PUT \
  --url 'https://api.regfish.com/domains/www.example.com/nameservers' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'content-type: application/json' \
  --data '{
  "vanity_set_id": 1
}'

Responses

200

Delegation after the change

application/jsonnameserversResponse

Response-Beispiel 200

{
  "success": true,
  "code": 0,
  "response": {
    "domain": "example",
    "mode": "standard",
    "current": [
      "example"
    ],
    "vanity_set_id": 1,
    "vanity_sets": [
      {
        "id": 1,
        "host": "example",
        "nameservers": [
          null
        ]
      }
    ]
  }
}

401

Unauthorized

application/jsonError

Response-Beispiel 401

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

403

Blocked by the Domain-Guardian

application/jsonError

Response-Beispiel 403

{
  "success": false,
  "message": "Blocked by the Domain-Guardian",
  "error": "Blocked by the Domain-Guardian"
}

404

Domain or vanity set not found

application/jsonError

Response-Beispiel 404

{
  "success": false,
  "message": "Domain or vanity set not found",
  "error": "Domain or vanity set not found"
}

409

Domain state or plan does not allow the change

application/jsonError

Response-Beispiel 409

{
  "success": false,
  "message": "Domain state or plan does not allow the change",
  "error": "Domain state or plan does not allow the change"
}

429

Daily change limit reached

application/jsonError

Response-Beispiel 429

{
  "success": false,
  "message": "Daily change limit reached",
  "error": "Daily change limit reached"
}

500

Unexpected error

application/jsonError

Response-Beispiel 500

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

Verwandte Modelle

baseResult

Error

fqdn_relaxed

Fully Qualified Domain Name.

nameserversResponse

nameserversUpdateRequest

Community

Werden Sie 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. Werden Sie Teil der Community und profitieren Sie von den Vorteilen der DNS-Automatisierung. Das DNS API steht jedem regfish-Kunden kostenlos zur Verfügung.

Weitere Gratis-Features