DNS API

Support Wissensdatenbank

Du bist hier:
Print

DNS API

This guide explains how to use our DNS API.

 

Step 1: Enable API Access

Before you can use the DNS API, go to admin.firestorm.ch and log in with your FireStorm ID. Enable the DNS API under Account => Customer Profile => API Access.

Step 2: Copy API Key

After activation, your personal API key will be displayed. Copy this key and use it for all API requests.

Step 3: Use the API

With API Key (recommended)

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

Alternative: Basic Auth (not recommended with special characters in password)

curl -u "YOUR_EMAIL:YOUR_PASSWORD" https://api.firestorm.ch/dns/v1/zones

 

API Endpoints

Zones

Method Endpoint Description
GET /dns/v1/zones List all zones
GET /dns/v1/zone/{id} Get a zone
PUT /dns/v1/zone/{id} Update entire zone (all records)

 

Single Records

Method Endpoint Description
GET /dns/v1/zone/{id}/records List all records of a zone
POST /dns/v1/zone/{id}/record Add single record
PUT /dns/v1/zone/{id}/record Update single record
DELETE /dns/v1/zone/{id}/record Delete single record

 

Examples

Get Zone ID

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

List Records

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

Add Record

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

Update Record

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

Delete Record

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

 

ACME DNS-01 Challenge

Automatic Propagation: For _acme-challenge.* records, the API automatically waits until all DNS servers have the record. The response contains propagation details:

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

 

More Examples

For PowerShell examples see: DNS API PowerShell Example

War dieser Artikel hilfreich?
0 out Of 5 Stars
5 Stars 0%
4 Stars 0%
3 Stars 0%
2 Stars 0%
1 Stars 0%
Wie können wir diesen Artikel verbessern?
Please submit the reason for your vote so that we can improve the article.
Brauchst du Hilfe?
Related Post