Documentation de l'API
REST API

Moniteurs DNS

Récupérer tous

GET https://uptimelock.com/api/dns-monitors/
curl --request GET \
--url 'https://uptimelock.com/api/dns-monitors/' \
--header 'Authorization: Bearer {api_key}' \
Paramètres Détails Description
search Facultatif Chaîne La chaîne de recherche.
search_by Facultatif Chaîne Par quel champ recherchez-vous ? Les valeurs autorisées sont : name, target.
is_enabled Facultatif Boolean
datetime_field Facultatif Chaîne Valeurs autorisées : datetime, last_datetime, last_check_datetime, last_change_datetime
datetime_start Facultatif Chaîne Filter results starting from this datetime. Y-m-d H:i:s format.
datetime_end Facultatif Chaîne Filter results up to this datetime. Y-m-d H:i:s format.
order_by Facultatif Chaîne Par quel champ trier les résultats. Les valeurs autorisées sont : dns_monitor_id, datetime, last_datetime, last_check_datetime, last_change_datetime, total_checks, total_changes, name.
order_type Facultatif Chaîne L'ordre des résultats. Les valeurs autorisées sont : ASC pour un ordre croissant et DESC pour un ordre décroissant.
page Facultatif Entier Le numéro de page à partir duquel vous souhaitez obtenir les résultats. Par défaut, il est défini sur 1.
results_per_page Facultatif Entier Combien de résultats souhaitez-vous par page. Les valeurs autorisées sont : 10, 25, 50, 100, 250, 500, 1000. Par défaut, cela correspond à 25. 
{
    "data": [
        {
            "id": 1,
            "project_id": 0,
            "name": "Sample",
            "target": "example.com",
            "dns": {
                "A": [
                    {
                        "host": "example.com",
                        "ip": "12.12.12.12"
                    }
                ],
                "CNAME": [],
                "HINFO": [],
                "CAA": [],
                "MX": [],
                ...
            },
            "notifications": [1],
            "settings": {
                "dns_check_interval_seconds": 300
            },
            "total_checks": 1,
            "total_changes": 0,
            "last_check_datetime": "2024-01-03 01:48:42",
            "next_check_datetime": "2024-01-03 01:49:13",
            "last_change_datetime": null,
            "is_enabled": true,
            "datetime": "2026-10-15 23:05:20",
            "last_datetime": null
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://uptimelock.com/api/dns-monitors?page=1",
        "last": "https://uptimelock.com/api/dns-monitors?page=1",
        "next": null,
        "prev": null,
        "self": "https://uptimelock.com/api/dns-monitors?page=1"
    }
}

Récupérer un

GET https://uptimelock.com/api/dns-monitors/{dns_monitor_id}
curl --request GET \
--url 'https://uptimelock.com/api/dns-monitors/{dns_monitor_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "project_id": 0,
        "name": "Sample",
        "target": "example.com",
        "dns": {
            "A": [
                {
                    "host": "example.com",
                    "ip": "12.12.12.12"
                }
            ],
            "CNAME": [],
            "HINFO": [],
            "CAA": [],
            "MX": [],
            ...
        },
        "notifications": [1],
        "settings": {
            "dns_check_interval_seconds": 300
        },
        "total_checks": 1,
        "total_changes": 0,
        "last_check_datetime": "2024-01-03 01:48:42",
        "next_check_datetime": "2024-01-03 01:49:13",
        "last_change_datetime": null,
        "is_enabled": true,
        "datetime": "2026-10-15 23:05:20",
        "last_datetime": null
    }
}

Créer

POST https://uptimelock.com/api/dns-monitors
Paramètres Détails Description
name Requis Chaîne -
target Requis Chaîne -
project_id Facultatif Entier -
notifications Facultatif Tableau Identifiants de gestionnaire de notification
dns_check_interval_seconds Facultatif Entier Valeurs autorisées : 300, 600, 1800, 3600, 21600, 43200, 86400 (secondes)
dns_types Facultatif Tableau Valeurs autorisées : A, CNAME, CAA, MX, NS, SOA, TXT, AAAA
is_enabled Facultatif Boolean -
curl --request POST \
--url 'https://uptimelock.com/api/dns-monitors' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
--form 'target=example.com' \
{
    "data": {
        "id": 1
    }
}

Mise à jour

POST https://uptimelock.com/api/dns-monitors/{dns_monitor_id}
Paramètres Détails Description
name Requis Chaîne -
target Requis Chaîne -
project_id Facultatif Entier -
notifications Facultatif Tableau Identifiants de gestionnaire de notification
dns_check_interval_seconds Facultatif Entier Valeurs autorisées : 300, 600, 1800, 3600, 21600, 43200, 86400 (secondes)
dns_types Facultatif Tableau Valeurs autorisées : A, CNAME, CAA, MX, NS, SOA, TXT, AAAA
is_enabled Facultatif Boolean -
curl --request POST \
--url 'https://uptimelock.com/api/dns-monitors/{dns_monitor_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
{
    "data": {
        "id": 1
    }
}

Supprimer

DELETE https://uptimelock.com/api/dns-monitors/{dns_monitor_id}
curl --request DELETE \
--url 'https://uptimelock.com/api/dns-monitors/{dns_monitor_id}' \
--header 'Authorization: Bearer {api_key}' \