Eine Domain hinzufügen¶
Note
Wenn das automatische Update deaktiviert ist, werden Änderungen an Ihrer Konfiguration erst übernommen, wenn Sie das automatische Update wieder aktivieren. Die Deaktivierung des automatischen Updates dient in erster Linie dazu, viele Einstellungen auf einmal zu ändern, damit Myra keine halbfertige Konfiguration ausrollt. In einigen Fällen deaktiviert auch der Myra-Support diese Option, um zu verhindern, dass das Myra-System spezielle Konfigurationseinstellungen entfernt. Beachten Sie, dass das Deaktivieren von autoUpdate nicht mit Datenbanktransaktionen zusammenhängt. Alle vorgenommenen Änderungen werden gespeichert, aber nicht ausgerollt.
Note
Wenn die optionalen Attribute nicht gesetzt sind, setzt das System einen Standardwert ein.
Note
Der Body enthält die Attribute id, created und modified nicht. Die Werte dieser Attribute werden vom System nach dem Erstellen der Einträge gesetzt.
Senden einer POST-Anfrage an den Endpunkt /domains.
Beschreibung¶
Mit der Add-Domain-Anfrage fügen Sie der Organisation eine Domain hinzu.
Voraussetzungen¶
Werte der Anfrage: keine
Objekte: DomainVO
Anfrage¶
Um eine Domain hinzuzufügen, müssen dem Pfad der Anfrage keine weiteren Informationen hinzugefügt werden.
Für eine detaillierte Spezifikation, welche Informationen zum Hinzufügen einer Domain erforderlich sind, muss im Body ein Objekt DomainVO mit den folgenden Attributen definiert werden:
| Attribut | Beschreibung | Werte |
|---|---|---|
name |
Der Name der Domain. | string |
Die folgenden Attribute sind optional:
| Attribut | Beschreibung | Werte |
|---|---|---|
autoUpdate |
Die Verfügbarkeit des automatischen Updates für die Domain. |
|
autoDns |
Legt fest, ob die autoDns-Funktion zur automatischen Suche nach möglichen Subdomains beim Erstellen einer neuen Domain aktiviert ist. |
|
maintenance |
Die Verfügbarkeit einer vorhandenen Wartungsseite für die ausgewählte Domain. |
|
Das System gibt als Antwort das Objekt DomainVO mit den Informationen zum neuen Eintrag zurück.
Beispiel¶
Beispiel-Request-Body:
{
"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",
"enabled": true,
"comment": "string"
}
],
"reversed": true,
"environment": "string",
"locked": true,
"tagId": 0,
"permissions": "string",
"label": "string"
}
Antworten¶
Die folgenden Antworten sind möglich:
| STATUSCODE | BESCHREIBUNG |
|---|---|
| 201 | Die Anfrage war erfolgreich und ein neues Objekt wurde erstellt. |
| 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. |