Subdomains

Es gibt drei Typen von Subdomains:

webspace: Volles Webhosting und E-Mail.
redirect: HTTP-Redirect und E-Mail.
email: Subdomain die ausschließlich für E-Mail genutzt wird.

GET /subdomains

Liefert eine Liste von Subdomains für den aktuellen Kunden.

Mögliche Filter:

package_id: Pakete
domain: Domains als Strings; z.B. variomedia.de

GET /subdomains/{id}

Liefert Details zur Subdomain mit der ID {id}.

Erstellen

POST /subdomains

Erstellt eine neue Subdomain anhand des POST-Bodys.

Webspace

Ein Beispiel für einen POST-Body, der eine Webspace-Subdomain „sub“ für die Domain „domain.de“ anlegt, die auf den Pfad „/sub-webspace/“ zeigt:

{
  "data": {
    "type": "subdomain",
    "attributes": {
      "subdomain_type": "webspace",
      "description": "Eine freiwillige Beschreibung.",
      "domain": "domain.de",
      "subdomain": "sub",
      "webspace": {
        "path": "/sub-webspace/"
      }
    }
  }
}

Optional kann zusätzlich eine php_version als String übergeben werden, die standardmäßig für PHP-Skripte verwendet wird. Beim Weggelassen wird automatisch die empfohlene PHP-Version verwendet.

Derzeit sind folgende Versionen zulässig:

"5.6" (keine Sicherheitsupdates mehr verfügbar!)
"7.1" (keine Sicherheitsupdates mehr verfügbar!)
"7.2" (keine Sicherheitsupdates mehr verfügbar!)
"7.3" (keine Sicherheitsupdates mehr verfügbar!)
"7.4" (keine Sicherheitsupdates mehr verfügbar!)
"8.0" (keine Sicherheitsupdates mehr verfügbar!)
"8.1" (unterstützt bis 25.11.2024)
"8.2" (unterstützt bis 08.12.2025)
"8.3" (unterstützt bis 23.11.2026)

Ein Beispiel für einen POST-Body, der eine Redirect-Subdomain „sub“ für die Domain „domain.de“ anlegt, die Zugriffe nach „sub2.domain.de“ mittels eines Location-Headers weiterleitet und den Pfad dynamisch umschreibt:

{
  "data": {
    "type": "subdomain",
    "attributes": {
      "subdomain_type": "redirect",
      "description": "Eine freiwillige Beschreibung.",
      "domain": "domain.de",
      "subdomain": "sub",
      "redirect": {
        "dynamic": true,
        "target": "https://sub2.domain.de/"
      }
    }
  }
}

Ist dynamic auf false gesetzt, wird hart auf die target-URL umgeleitet. Wenn es true ist, wird der Pfad übernommen. Also z.B. https://sub.domain.de/foo/bar würde auf https://sub2.domain.de/foo/bar umleiten.

Für die target-URL gelten die gleichen Regeln, wie im Kundenmenü.

Email

Ein Beispiel für einen POST-Body, der eine Email-Subdomain „sub“ für die Domain „domain.de“ anlegt:

{
  "data": {
    "type": "subdomain",
    "attributes": {
      "subdomain_type": "email",
      "description": "Eine freiwillige Beschreibung.",
      "domain": "domain.de",
      "subdomain": "sub"
    }
  }
}

Manipulation

PATCH /subdomains/{id}

Erlaubt die Manipulation existierender Subdomains. Bitte beachten Sie, dass die ID in der URL und das id-Feld im Body identisch sein müssen.

PHP-Version

Für Webspace-Subdomains können Sie die Standard-PHP-Version setzen:

{
  "data": {
    "type": "subdomain",
    "id": "42",
    "attributes": {
      "webspace": {
        "php_version": "7.4"
      }
    }
  }
}

Für gültige Versionen, vergleichen Sie bitte die Liste von oben. Bei null wird die Standardversion des Pakets, in dem sich die Subdomain befindet, verwendet.

Pfad zu Webspace

Um den Webspace-Pfad zu setzen:

{
  "data": {
    "type": "subdomain",
    "id": "42",
    "attributes": {
      "webspace":{
        "path": "/ihr/wordpress/"
      }
    }
  }
}

Wenn Sie den Webspace-Pfad für eine Redirect- oder eine Email-Subdomain PATCHen, wird sie automatisch in eine Webspace-Subdomain umgewandelt.

Redirect-Ziel

Um die Ziel-URL einer Redirect-Subdomain zu ändern:

{
  "data": {
    "type": "subdomain",
    "id": "42",
    "attributes": {
      "redirect": {
        "target": "https://beispielkunde.info/"
      }
    }
  }
}

Sollte die Subdomain bisher uninitialisiert sein (d.h in der Liste erscheint sie als Weiterleitung, jedoch ohne Weiterleitungsdaten), wird im gleichen Schritt die Weiterleitung as statisch eingerichtet.

Wenn Sie die Ziel-URL für eine Webspace- oder eine Email-Subdomain PATCHen, wird sie automatisch in eine statische Redirect-Subdomain umgewandelt.

Dynamische Redirects

Sie können eine Redirect-Subdomain dynamisch machen (oder nicht). Bitte beachten Sie, dass um eine Redirect-Subdomain dynamisch zu machen, die Ziel-URL mit einem / enden muss.

{
  "data": {
    "type": "subdomain",
    "id": "42",
    "attributes": {
      "redirect": {
        "dynamic": true
      }
    }
  }
}

Es ist nicht möglich dies für uninitialisierte Subdomains anzuwenden.

Automatische Weiterleitung zu HTTPS

Um das redirect_to_https-Attribut zu manipulieren, benutzen Sie

{
  "data": {
    "type": "subdomain",
    "id": "42",
    "attributes": {
      "redirect": {
        "redirect_to_https": true
      }
    }
  }
}

für Redirect-Subdomains bzw.

{
  "data": {
    "type": "subdomain",
    "id": "42",
    "attributes": {
      "webspace": {
        "redirect_to_https": true
      }
    }
  }
}

für Webhosting-Subdomains.

Es ist nicht möglich dies für uninitialisierte Redirect-Subdomains anzuwenden.

Variomedia Kunden-API