Alle Domains und Domain-Konfigurationen auflisten¶
Senden einer GET-Anfrage an den Endpunkt /domains.
Beschreibung¶
Mit der List-Domains-Anfrage rufen Sie eine Liste aller Domains und ihrer Konfiguration der Organisation ab.
Voraussetzungen¶
Werte der Anfrage: keine
Objekte: keine
Anfrage¶
Um eine Liste aller Domains und ihrer Konfiguration abzurufen, müssen dem Pfad der Anfrage keine weiteren Informationen hinzugefügt werden.
Als Ergebnis erhalten Sie ein Objekt DomainVO mit den angefragten Informationen.
Das Objekt liefert die folgenden Informationen:
| Attribut | Beschreibung | Werte |
|---|---|---|
name |
Der Name der Domain. | string |
organizationId |
Die ID der Organisation in der Myra App, unter der die Domain erstellt wurde. | string |
autoUpdate |
Die Verfügbarkeit des automatischen Updates für die Domain. |
|
maintenance |
Die Verfügbarkeit einer vorhandenen Wartungsseite für die ausgewählte Domain. |
|
dnsRecords |
Ein Array mit einem oder mehreren Objekten DnsRecordVO mit Informationen zu den DNS-Einträgen der Domain. |
Weitere Informationen finden Sie beim Endpunkt GET /domain/{domainId}/load-balancing. |
reversed |
Ein boolescher Wert, der angibt, ob die Domain in umgekehrter Domainnamen-Notation vorliegt. |
|
environment |
Der Umgebungstyp der Domain. Der Umgebungstyp test kann verwendet werden, um eine Konfiguration einzurichten und sie gemeinsam mit dem Myra-Support zu prüfen, bevor sie ausgerollt wird. |
|
locked |
Legt fest, ob die Domain im System gesperrt und nicht mehr verfügbar ist. Das Sperren unterscheidet sich vom Löschen, da die Domain als vorhandener Eintrag bestehen bleibt. |
|
id |
Die ID des Eintrags. | integer |
modified |
Das Datum der letzten Änderung im ISO-8601-Format. | string($date-time) |
created |
Das Erstellungsdatum im ISO-8601-Format. | string($date-time) |
Beispiel¶
Beispiel-Antwort:
[
{
"objectType": "string",
"name": "string",
"organizationId": 0,
"autoDns": true,
"autoUpdate": true,
"maintenance": true,
"paused": true,
"pausedUntil": "string",
"template": "string",
"dnsRecords": [
{
"objectType": "string",
"name": "string",
"value": "string",
"priority": 0,
"ttl": 0,
"vhostId": 0,
"recordType": "string",
"weight": 0,
"port": 0,
"active": true,
"paused": true,
"sslCertTemplate": "string",
"upstreamOptions": "string",
"alternativeCname": "string",
"environment": "string",
"caaFlags": 0,
"caaTag": "string",
"endpoints": "string",
"serviceType": 0,
"encryption": "string",
"identificationNumber": "string",
"hashType": "string",
"id": 0,
"modified": "string",
"created": "string",
"enabled": true,
"comment": "string"
}
],
"reversed": true,
"environment": "string",
"locked": true,
"tagId": 0,
"permissions": "string",
"id": 0,
"modified": "string",
"created": "string",
"label": "string"
}
]
Antworten¶
Die folgenden Antworten sind möglich:
| STATUSCODE | BESCHREIBUNG |
|---|---|
| 200 | Die Anfrage war erfolgreich. |
| 400 | Die Anfrage war nicht erfolgreich. Die Anfrage war fehlerhaft oder es fehlen Informationen. |
| 401 | Die Anfrage war nicht erfolgreich, da die Authentifizierung fehlerhaft war. |
| 403 | Die Anfrage war nicht erfolgreich, da die erforderlichen Berechtigungen fehlen. |