DNS API

Skip to main content
Du bist hier:
Drucken

DNS API

DNS API

Mit dieser Anleitung erklären wir dir, wie du unsere DNS API verwenden kannst.

 

Schritt 1: API-Zugang aktivieren

Bevor du die DNS-API verwenden kannst, gehe zu admin.firestorm.ch und melde dich mit deiner FireStorm-ID an. Aktiviere die DNS-API unter Konto => Kundenprofil => API Zugang.

Schritt 2: API-Key kopieren

Nach der Aktivierung wird dein persönlicher API-Key angezeigt. Kopiere diesen Key und verwende ihn für alle API-Anfragen.

Schritt 3: API verwenden

Verwende den API-Key im X-API-Key Header:

curl -H "X-API-Key: DEIN_API_KEY" https://api.firestorm.ch/dns/v1/zones

 

API Endpunkte

Zonen

Methode Endpunkt Beschreibung
GET /dns/v1/zones Alle Zonen auflisten

 

Einzelne Records

Methode Endpunkt Beschreibung
GET /dns/v1/zone/{id}/records Alle Records einer Zone auflisten
POST /dns/v1/zone/{id}/record Einzelnen Record hinzufügen
PUT /dns/v1/zone/{id}/record Einzelnen Record ändern
DELETE /dns/v1/zone/{id}/record Einzelnen Record löschen

 

Beispiele

Zone-ID ermitteln

curl -H "X-API-Key: DEIN_API_KEY" https://api.firestorm.ch/dns/v1/zones

Antwort:

{
    "status": "OK",
    "zones": [
        {"id": 123, "name": "example.ch"},
        {"id": 456, "name": "example.com"}
    ]
}

Records auflisten

curl -H "X-API-Key: DEIN_API_KEY" https://api.firestorm.ch/dns/v1/zone/123/records

Record hinzufügen

curl -X POST -H "X-API-Key: DEIN_API_KEY" -H "Content-Type: application/json" \
  -d x27{"name":"test.example.ch.","type":"A","data":"192.168.1.1","ttl":3600}x27 \
  https://api.firestorm.ch/dns/v1/zone/123/record

Record ändern

curl -X PUT -H "X-API-Key: DEIN_API_KEY" -H "Content-Type: application/json" \
  -d x27{"name":"test.example.ch.","type":"A","old_data":"192.168.1.1","data":"192.168.1.2","ttl":3600}x27 \
  https://api.firestorm.ch/dns/v1/zone/123/record

Record löschen

curl -X DELETE -H "X-API-Key: DEIN_API_KEY" -H "Content-Type: application/json" \
  -d x27{"name":"test.example.ch.","type":"A","data":"192.168.1.2"}x27 \
  https://api.firestorm.ch/dns/v1/zone/123/record

 

Erlaubte Record-Typen

A, AAAA, CNAME, MX, TXT, NS, SRV, CAA, PTR

Validierung

  • A: Muss eine gültige IPv4-Adresse sein
  • AAAA: Muss eine gültige IPv6-Adresse sein
  • CNAME: Muss ein FQDN mit Punkt am Ende sein (z.B. example.ch.)
  • TXT: Wird automatisch in Anführungszeichen gewrappt
  • TTL: Minimum 60, Maximum 86400, Standard 3600

 

ACME DNS-01 Challenge

Automatische Propagation: Bei _acme-challenge.* Records wartet die API automatisch, bis alle DNS-Server den Eintrag haben. Die Antwort enthält Details zur Propagation:

{
    "status": "OK",
    "record_id": 12345,
    "propagation": {
        "propagated": true,
        "time": 45,
        "servers": {
            "dns11.firestorm.ch": true,
            "dns12.firestorm-isp.com": true,
            "dns13.firestorm-isp.com": true,
            "dns14.firestorm.ch": true
        }
    }
}

 

Weitere Beispiele

Für PowerShell-Beispiele siehe: DNS API PowerShell Beispiel

Related Post