From 479efe4b2666d66ebeda4aa67a01c22e24626583 Mon Sep 17 00:00:00 2001 From: Thomas Brinkmann Date: Thu, 2 Jun 2022 15:11:34 +0200 Subject: [PATCH] =?UTF-8?q?=E2=80=9EGET=20/dns/zones=E2=80=9C=20=C3=A4nder?= =?UTF-8?q?n?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- GET-%2Fdns%2Fzones.md | 88 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 88 insertions(+) create mode 100644 GET-%2Fdns%2Fzones.md diff --git a/GET-%2Fdns%2Fzones.md b/GET-%2Fdns%2Fzones.md new file mode 100644 index 0000000..9ebe6a9 --- /dev/null +++ b/GET-%2Fdns%2Fzones.md @@ -0,0 +1,88 @@ +## **GET /order** + + +## **Inhalt** +--- +- Parameter +- Optionale Parameter +- Beispiel Anfrage +- Beispiel Antwort +- Mögliche Fehlermeldungen +--- + +### Parameter + +|URL Parameter | Typ | Beschreibung| +|----------|-----|-------------| +|- | -| - + +|Body Parameter | Typ | Beschreibung| +|----------|-----|-------------| +| - | - | - | + + +--- + +### Optionale Parameter + +|Query-String Parameter | Typ | Beschreibung| +|----------|-----|-------------| +|?page | integer | Beschreibt die aktuelle Seitenzahl +|?limit | integer | Beschreibt wieviele Elemente pro Seite angezeigt werden sollen + +--- + +### Beispiel Anfrage + +##### PHP +```php + 'control.local/api/v2/dns/zones', + CURLOPT_CUSTOMREQUEST => 'GET', + CURLOPT_HTTPHEADER => array( + 'X-TOKEN: test-token', + 'Content-Type: application/json' + ), +)); + +$response = curl_exec($curl); + +curl_close($curl); +echo $response; +``` + +##### cURL +```bash +curl --location --request GET 'control.local/api/v2/dns/zones' \ +--header 'X-TOKEN: test-token' \ +--header 'Content-Type: application/json' +``` + +--- + +### Beispiel Antwort + +```json +{ + "status": "OK", + "totalResults": 5, + "page": 1, + "itemsPerPage": 10, + "maxPages": 1, + "items": [ + "domain1.de", + "domain2.de", + "domain3.de", + "domain4.de", + "domain5.de" + ] +} +``` + +### Mögliche Fehlermeldungen + +> :warning: Status Code **403** - Permission denied