DNS API-Referenz
v1.10.0
Ask the regfish assistant
Put a question to Flossi, the regfish assistant, and get back the answer it would give in the dashboard chat. Same assistant, same knowledge base (help center articles, curated procedures, the service FAQ derived from the console itself, the legal pages and the developer documentation), same access to the account behind the API key. Ask it before describing a click path: the assistant knows the exact menu names, and those are what invented instructions get wrong. It also answers questions no article covers, because they are about this account: when a domain expires, which domains have no DNSSEC, whether anything is unpaid. Account data follows the key's own permissions. A key with domain:read gets domain answers; billing answers need billing:read, certificate answers need tls:read. Without the right the assistant leaves that part out rather than refusing the whole question. The answer is Markdown and may link places in the dashboard as relative paths (/my/...). Resolve them against dashboard_url from the response. One question at a time: the assistant runs on a single local GPU. A busy assistant answers 503, and so does one that cannot be reached. Rate limit: 10 questions per minute and API key, 20 per 10 minutes and account.
GET
/help/search
Help
Authentifizierung
Parameter
Name
Typ
Format
Pflicht
Description
locale
string
-
Optional
Answer language and the regfish world the assistant links to. Omitted, it answers in the language of the question and links to regfish.de. `it` and `pl` are deprecated: regfish no longer offers these languages, they are answered like `en`.
q
string
-
Pflicht
The question, in the customer's own words. There is no conversation state: each call stands alone, so a follow-up has to carry its own context ("when does example.de expire?", not "and when does it?").
Request-Beispiel
GET
curl --request GET \
--url 'https://api.regfish.com/help/search?locale=de&q=example' \
--header 'x-api-key: YOUR_API_KEY'Responses
200
The assistant's answer
Response-Beispiel 200
{
"success": true,
"code": 0,
"response": {
"question": "example",
"answer": "example",
"truncated": true,
"sources": "example",
"dashboard_url": "example"
}
}400
Missing or invalid query
Response-Beispiel 400
{
"success": false,
"message": "Missing or invalid query",
"error": "Missing or invalid query"
}401
Unauthorized
Response-Beispiel 401
{
"success": false,
"message": "Unauthorized",
"error": "Unauthorized"
}403
Assistant not available for this credential or account
Response-Beispiel 403
{
"success": false,
"message": "Assistant not available for this credential or account",
"error": "Assistant not available for this credential or account"
}429
Too many questions
Response-Beispiel 429
{
"success": false,
"message": "Too many questions",
"error": "Too many questions"
}500
Unexpected error
Response-Beispiel 500
{
"success": false,
"message": "Unexpected error",
"error": "Unexpected error"
}503
Assistant busy or unreachable, retrying later is worth it
Response-Beispiel 503
{
"success": false,
"message": "Assistant busy or unreachable, retrying later is worth it",
"error": "Assistant busy or unreachable, retrying later is worth it"
}Verwandte Modelle
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.