Help Center
Login Sign up
  1. Home
  2. API reference
  3. General API basics
  4. AutoDNS messages

Retrieving system notifications - polling and push

API reference (XML/JSON) · Updated 2025-01-02

Polling, push and email methods are available for retrieving notifications from the queue.

Polling

Polling is the active retrieval of system notifications from the queue by the user. The notifications are in a structured format and are processed according to the FIFO principle.
Polling is performed in two steps: the last message is retrieved and the retrieval is then confirmed.

Get notifications

  • JSON: The current system notification can be retrieved via the GET /poll route.
  • XML: The current system notification can be retrieved via the task 0905.
  • EPP: If EPP is activated, the user is automatically set to polling.

Examples  for JSON, XML and EPP

GET /poll
{
    "stid": "20210505-app4-106167",
    "status": {
        "code": "S0905",
        "text": "The notification was polled successfully.",
        "type": "SUCCESS"
    },
    "object": {
        "type": "Message",
        "value": "51646140",
        "summary": 1
    },
    "data": [
        {
            "id": 51646140,
            "job": {
                "created": "2021-05-05T10:22:04.000+0200",
                "updated": "2021-05-05T10:22:12.000+0200",
                "status": "SUCCESS",
                "execution": "2021-05-05T10:22:04.000+0200",
                "subType": "BASIC_SSL",
                "action": "create",
                "id": 28983240
            },
            "stid": "20210505-app1-102766",
            "object": {
                "type": "Certificate",
                "value": "domain.de",
                "data": {
                    "created": "2021-05-05T00:00:00.000+0200",
                    "updated": "2021-05-05T10:22:12.000+0200",
                    "id": 2452924,
                    "partnerOrderId": "IX-CC-28983240",
                    "orderId": "033328606",
                    "adminContact": {
                        "id": -1
                    },
                    "technicalContact": {
                        "fname": "Max",
                        "lname": "Mustermann",
                        "phone": "+49-941-59559463",
                        "fax": "+49-941-59559463",
                        "email": "max.mustermann@internetx.com",
                        "title": "Admin",
                        "organization": "InterNetX GmbH",
                        "address": [
                            "Johanna-Dachs-Str. 55"
                        ],
                        "pcode": "93055",
                        "city": "Regensburg",
                        "country": "DE",
                        "state": "BY",
                        "id": 30176
                    },
                    "name": "domain.de",
                    "lifetime": {
                        "unit": "MONTH",
                        "period": 12
                    },
                    "software": "APACHE2",
                    "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIICvDCCAaQCAQAwdzELMAkGA1UEBhMCREUxCzAJBgNVBAgMAkJZMRMwEQYDVQQH\nDApSZWdlbnNidXJnMRcwFQYDVQQKDA5JbnRlck5ldFggR21iSDEUMBIGA1UECwwL\nRW50d2lja2x1bmcxFzAVBgNVBAMMDmp1bmtkcmFnb25zLmRlMIIBIjANBgkqhkiG\n9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzgUABWcrarE++2bCqLJMtuSq5Z3okflkLtw8\ngwHP6+7KM50ltNWhZUf/R++2kbpO8AXQA5wsO/vb5QDDgxJAmbBIzDxvQrirKNwF\naQJPVNlolJI13YvFsSQ7YWn3vxjBIQW+qlL8YNjfizea5qiwM6FCIJ5aY8q3+RaP\nCNWR5XAZGEKwdSTAweAEBp5GzwjZ72zx3+dSpKj20Ji+VeYS0nYvuQX3YRzViY/M\nwhmtEJS9zr7JonvJDyh6EuTHgqmQVz+dC9SoZcQC5MQCwBMYvOVB4L5Ah4bCZWNp\n5ufCljVCExjjj6hgTYVQHTo2jrkT6NVtwM1hG7D3VjzbIVre8QIDAQABoAAwDQYJ\nKoZIhvcNAQELBQADggEBAEdP4jPioxnx4q9XDCk0GBZEIAGvasuz6vE5ezlzcGt9\nVsUlZKdxdAA6dVXyajIaGRgO5fniJEn3o+uUjAHhY7lnav91g9cnEx41QDYwmM+F\nkpoyj26j6PYHITXv4skT2vgahnP6K4Bz5sACLchzBJ1VvXeGp1AZmtq7rwNkD49l\nLE9J9tvhjSTo3gz9EY4YbrkGj56RRx7RMYNE7kRgEYznRjbSESeF9KMOxHiLKMxf\nMEDgFhTdHTSG67d3pdyC25XO3IJivSmcBHlYje6doapjqyRXrxXfYWU965sgOV+Q\n3LvEP1hIWOJj1uQhH42XpU0jm9vhh8jC9r7WSACuPYk=\n-----END CERTIFICATE REQUEST-----",
                    "server": "-----BEGIN CERTIFICATE-----\nMIIGBDCCBOygAwIBAgIQAexg7sxHPhooDFCMKrM3vTANBgkqhkiG9w0BAQsFADBu\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3\nd3cuZGlnaWNlcnQuY29tMS0wKwYDVQQDEyRFbmNyeXB0aW9uIEV2ZXJ5d2hlcmUg\nRFYgVExTIENBIC0gRzEwHhcNMjEwNTA1MDAwMDAwWhcNMjIwNTA1MjM1OTU5WjAZ\nMRcwFQYDVQQDEw5qdW5rZHJhZ29ucy5kZTCCASIwDQYJKoZIhvcNAQEBBQADggEP\nADCCAQoCggEBAM4FAAVnK2qxPvtmwqiyTLbkquWd6JH5ZC7cPIMBz+vuyjOdJbTV\noWVH/0fvtpG6TvAF0AORszv72+UAw4MSQJmwSMw8b0K4qyjcBWkCT1TZaJSSNd2L\nxbEkO2Fp978YwSEFvqpS/GDY34s3muaosDOhQiCeWmPKt/kWjwjVkeVwGRhCsHUk\nwMHgBAaeRs8I2e9s8d/nUqSo9tCYvlXmEtJ2L7kF92Ec1YmPzMIZrRCUvc6+yaJ7\nyQ8oehLkx4KpkFc/nQvUqGXEAuTEAsATGLzlQeC+QIeGwmVjaebnwpY1QhMY44+o\nYE2FUB06No65E+jVbcDNYRuw91Y82yFa3vECAwEAAaOCAvEwggLtMB8GA1UdIwQY\nMBaAFFV0T7JyT/VgulDR1+ZRXJoBhxrXMB0GA1UdDgQWBBRXyIeOmajF8etYxeQM\nLcsfUQ5YpTAtBgNVHREEJjAkgg5qdW5rZHJhZ29ucy5kZYISd3d3Lmp1bmtkcmFn\nb25zLmRlMA4GA1UdDwEB/wQEAwIFoDAdBgNVHSUEFjAUBggrBgEeBQcDAQYIKwYB\nBQUHAwIwPgYDVR0gBDcwNTAzBgZngQwBAgEwKTAnBggrBgEFBQcCARYbaHR0cDov\nL3d3dy5kaWdpY2VydC5jb20vQ1BTMIGABggrBgEFBQcBAQR0MHIwJAYIKwYBBQUH\nMAGGGGh0dHA6Ly9vY3NwLmRpZ2ljZXJ0LmNvbTBKBggewgEFBQcwAoY+aHR0cDov\nL2NhY2VydHMuZGlnaWNlcnQuY29tL0VuY3J5cHRpb25FdmVyeXdoZXJlRFZUTFND\nQS1HMS5jcnQwCQYDVR0TBAIwADCCAX0GCisGAQQB1nkCBAIEggFtBIIBaQFnAHYA\nKXm+8J45OSHwVnOfY6V35b5XfZxgCvj5TV0mXCVdx4QAAAF5O57AIQAABAMARzBF\nAiEA4hM/fAE7YznaYj7md1NphwBXPWvAtKsdSR7IEsWBW7cCIA3P8V2D0/0F4YDP\ntm9XMLXpDLkgG5c/hQ5j0UH0Q4DXAHYAIkVFB1lVJFaWP6Ev8fdthuAjJmOtwEt/\nXcaDXG7iDwIAAAF5O57AXwAABAMARzBFAiBnSs0Ho3P06bgGj//GqBfR+py91O/t\napFmOt0BysQ8oAIhAJuGQHji/A+2xXYv8B57XydDyeUgthe3RUf5mK8+d9+bAHUA\nUaOw9f0BeZxWbbg3eI8MpHrMGyfL956IQpoN/tSLBeUAAAF5O56+sAAABAMARjBE\nAiAn5OYBibR9/ZXkQU+ERPyTR/JiYSun/ZV0G9nQgc9drwIgATNi2YE8YR/V6EWf\nLCdaoN5uambdalpjD76etECrSI4wDQYJKoZIhvcNAQELBQADggEBAH6p0o8Byyew\naZxfx61UBGqOczMP6dWa0e6jRX8xoCWo2071CEBbMgvHvqywF4weTqVD6CwG7srP\ne4j1xmXLWTqBQtf6xxfgv/CxHUO37s+011sERqsAvLbhpslWw74sLJ9Bim575Sf3\n0aAgz7hJpZjgv3+LV4puwI7u0zmjE+9rv7Ml3yoneQMNMd8mVaAhAiBmYbApujsT\nJ8bdmtKDG7q5Z2Xou3cUqNlR1sr2wDIAJjjr0fqtox7+zE/tWfPmfe0RlognYuSe\npRSYvRBTggKwylmbohS6VrlJMq2nTiZb1hoHfoGNJ2YiKyW2+xfQlEdY0+YPzePa\nTf2eRsOJIf8=\n-----END CERTIFICATE-----",
                    "serialNumber": "01EC60EBBC473E1A280C508C2AB337BD",
                    "product": "BASIC_SSL",
                    "signatureHashAlgorithm": "SHA2",
                    "expire": "2022-05-06T01:59:59.000+0200",
                    "payable": "2022-05-05T00:00:00.000+0200",
                    "extension": {},
                    "certificationAuthority": [
                        {
                            "caType": "INTERMEDIATE",
                            "caCertificate": "-----BEGIN CERTIFICATE-----\nMIIEqjCCA5KgAwIBAgIQAnmsRYvBskWr+YBTzSybsTANBgkqhkiG9w0BAQsFADBh\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3\nd3cuZGlnaWNlcnQuY29tMSAwHgYDVQQDExdEaWdpQ2VydCBHbG9iYWwgUm9vdCBD\nQTAeFw0xNzExMjcxMjQ2MTBaFw0yNzExMjcxMjQ2MTBaMG4xCzAJBgNVBAYTAlVT\nMRUwEwYDVQQKEwxEaWdpQ2VydCBJbmMxGTAXBgNVBAsTEHd3dy5kaWdpY2VydC5j\nb20xLTArBgNVBAMTJEVuY3J5cHRpb24gRXZlcnl3aGVyZSBEViBUTFMgQ0EgLSBH\nMTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALPeP6wkab41dyQh6mKc\noHqt3jRIxW5MDvf9QyiOR7VfFwK656es0UFiIa25a9pRntzF1UgYzDGu3ppZVMdo\nlbxhm6dWS9OK/lFehKNT0OYI9aqk6F+U7cA6jxSC+iDBPXwdF4rs3KRyp3aQn6pj\npp1yr7IB6Y4zv72Ee/PlZ/6rK6InC6WpK0nPVOYR7n9iDuPe1E4IxUMBH/T33+3h\nyuH3dvfgiWUOUkjdpMbyxX+XNle5uEIiyBsi4IvbcTCh8ruifCIi5mDXkZrnMT8n\nwfYCV6v6kDdXkbgGRLKsR4pucbJtbKqIkUGxuZI2t7pfewKRc5nWecvDBZf3+p1M\npA8CAwEAAaOCAU8wggFLMB0GA1UdDgQWBBRVdE+yck/1YLpQ0dfmUVyaAYca1zAf\nBgNVHSMEGDAWgBQD3lA1VtFMu2bwo+IbG8OXsj3RVTAOBgNVHQ8BAf8EBAMCAYYw\nHQYDVR0lBBYwFAYIKwYBBQUHAwEGCCsGAQUFBwMCMBIGA1UdEwEB/wQIMAYBAf8C\nAQAwNAYIKwYBBQUHAQEEKDAmMCQGCCsGAQUFBzABhhhodHRwOi8vb2NzcC5kaWdp\nY2VydC5jb20wQgYDVR0fBDswOTA3oDWgM4YxaHR0cDovL2NybDMuZGlnaWNlcnQu\nY29tL0RpZ2lDZXJ0R2xvYmFsUm9vdENBLmNybDBMBgNVHSAERTBDMDcGCWCGSAGG\n/WwBAjAqMCgGCCsGAQUFBwIBFhxodHRwczovL3d3dy5kaWdpY2VydC5jb20vQ1BT\nMAgGBmeBDAECATANBgkqhkiG9w0BAQsFAAOCAQEAK3Gp6/aGq7aBZsxf/oQ+TD/B\nSwW3AU4ETK+GQf2kFzYZkby5SFrHdPomunx2HBzViUchGoofGgg7gHW0W3MlQAXW\nM0r5LUvStcr82QDWYNPaUy4taCQmyaJ+VB+6wxHstSigOlSNF2a6vg4rgexixeiV\n4YSB03Yqp2t3TeZHM9ESfkus74nQyW7pRGezj+TC44xCagCQQOzzNmzEAP2SnCrJ\nsNE2DpRVMnL8J6xBRdjmOsC3N6cQuKuRXbzByVBjCqAA8t1L0I+9wXJerLPyErjy\nrMKWaBFLmfK/AHNF4ZihwPGOc7w6UHczBZXH5RFzJNnww+WnKuTPI0HfnVH8lg==\n-----END CERTIFICATE-----"
                        },
                        {
                            "caType": "ROOT",
                            "caCertificate": "-----BEGIN CERTIFICATE-----\nMIIDrzCCApegAwIBAgIQCDvgVpBCRrGhdWrJWZHHSjANBgkqhkiG9w0BAQUFADBh\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3\nd3cuZGlnaWNlcnQuY29tMSAwHgYDVQQDExdEaWdpQ2VydCBHbG9iYWwgUm9vdCBD\nQTAeFw0wNjExMTAwMDAwMDBaFw0zMTExMTAwMDAwMDBaMGExCzAJBgNVBAYTAlVT\nMRUwEwYDVQQKEwxEAAdpQ2VydCBJbmMxGTAXBgNVBAsTEHd3dy5kaWdpY2VydC5j\nb20xIDAeBgNVBAMTF0RpZ2lDZXJ0IEdsb2JhbCBSb290IENBMIIBIjANBgkqhkiG\n9w0BAQEFAAOCAQ8AMIIBCgKCAQEA4jvhEXLeqKTTo1eqUKKPC3eQyaKl7hLOllsB\nCSDMAZOnTjC3U/dDxGkAV53ijSLdhwZAAIEJzs4bg7/fzTtxRuLWZscFs3YnFo97\nnh6Vfe63SKMI2tavegw5BmV/Sl0fvBf4q77uKNd0f3p4mVmFaG5cIzJLv07A6Fpt\n43C/dxC//AH2hdmoRBBYMql1GNXRor5H4idq9Joz+EkIYIvUX7Q6hL+hqkpMfT7P\nT19sdl6gSzeRntwi5m3OFBqOasv+zbMUZBfHWymeMr/y7vrTC0LUq7dBMtoM1O/4\ngdW7jVg/tRvoSSiicNoxBN33shbyTApOB6jtSj1etX+jkMOvJwIDAQABo2MwYTAO\nBgNVHQ8BAf8EBAMCAYYwDwYDVR0TAQH/BAUwAwEB/zAdBgNVHQ4EFgQUA95QNVbR\nTLtm8KPiGxvDl7I90VUwHwYDVR0jBBgwFoAUA95QNVbRTLtm8KPiGxvDl7I90VUw\nDQYJKoZIhvcNAQEFBQADggEBAMucN6pIExIK+t1EnE9SsPTfrgT1eXkIoyQY/Esr\nhMAtudXH/vTBH1jLuG2cenTnmCmrEbXjcKChzUyImZOBBkXDiqw8cvpOp/2PV5Adg\n06O/nVsJ8dWO41P0jmP6P6fbtGbfYmbW0W5BjfIttep3Sp+dWOIrWcBAI+0tKIJF\nPnlUkiaY4IBIqDfv8NZ5YBberOgOzW6sRBc4L0na4UU+Krk2U886UAb3LujEV0ls\nYSEY1QSteDwsOoBrp+uvFRTp2InBuThs4pFsiv9kuXclVzDAGySj4dzp30d8tbQk\nCAUw7C29C79Fv1C5qfPrmAESrciIxpg0X40KPMbp1ZWVbd4=\n-----END CERTIFICATE-----"
                        }
                    ],
                    "authentication": {
                        "method": "DNS",
                        "dns": "_dnsauth.domain.de.\t300\tIN\tTXT\t\"202105050821384da655mdymr9p1y19scwx9lgt6s3daj1p7g1uzer3ydtmzcb6h\""
                    },
                    "certificateTransparencyPrivacy": "PUBLIC"
                }
            }
        }
    ]
}

Confirm notifications

  • JSON: A specific system notification can be confirmed via the route PUT /poll/{id}. The ID can be taken from the notification.
  • XML: A specific system notification can be confirmed with the task 0906. The ID can be taken from the notification.
Notifications are considered "successfully delivered" if they have been confirmed by the user.
If a notification is not confirmed by the user within 24 hours, it will be delivered to the fallback email (reply_to from the request).

Examples  for JSON, XML and EPP

PUT /poll/{id}
{
    "stid": "20180926-stid",
    "status": {
        "code": "S0906",
        "text": "The notification was confirmed successfully.",
        "type": "SUCCESS"
    },
    "object": {
        "type": "message",
        "value": "1819853"
    }
}

Push (Webhook)

Push is the passive retrieval of system notifications. The notifications are sent by the system to a specified address (URL) using HTTPS.The target can read the system notifications from the HTTP request body and must confirm receipt with an HTTP 200 OK.

Target adresses

The messages are sent via POST to the HTTPS destination address.

Redirect are not followed up.

Confirming notifications

Notifications are considered as "successfully delivered" if the server sends an HTTP Status 200 response.
If a notification cannot be sent within 24 hours, it will be delivered to the fallback email address (reply_to address in the request).

Source address of the push notifications

The source IP is 62.116.129.216. Configure your firewall accordingly so that the push notifications are not filtered out.

Example PHP script for writing the push message to a textfile

This script will process the PUSH Message and write it to output.txt.   Specify the URL where this script can be reached in the user profile under the API settings.

<?php
// Helper methods
function getHeaderList() {
        $headerList = array();
        foreach ($_SERVER as $name => $value) {
                if (preg_match('/^HTTP_/',$name)) {
                        $name = strtr(substr($name,5),'_',' ');
                        $name = ucwords(strtolower($name));
                        $name = strtr($name,' ','-');
                        // add to list
                        $headerList[$name] = $value;
                 }
        }
    return $headerList;
}

// Variables
$file = "output.txt";

// Fetch headers
$headers = "";
foreach (getHeaderList() as $name => $value) {
   $headers .= $name . ': ' . $value . "\n";
}

// Fetch body
$body = file_get_contents('php://input');

// Fetch current date
$now = date('Y-m-d H:i:s', time());

$content = "Date: $now\nHeaders: $headers\nBody: $body\n---------------------------------------------------------------------------------\n";

// Write to file
file_put_contents($file, $content, FILE_APPEND);
?>

Email

Notifications are sent by email (default setting).

Frequently used

↗ TLD knowledge base ↗ Policies & troubleshooting ↗ Domains ↗ TLS/SSL & S/MIME ↗ Server & Cloud