Skip to main content
POST
Custom Domain festlegen
Du benötigst mindestens den Standard-Plan, um diese Route zu nutzen. Dasselbe Konto kann eine Domain an mehrere Anwendungen binden (Load Balancing): bis zu 2 Anwendungen im Standard-, 5 im Pro- und 10 im Enterprise-Plan. Siehe Load Balancer auflisten.
string
erforderlich
Der API-Schlüssel für dein Konto. Du findest ihn in deinen Kontoeinstellungen.
Erfordert einen API-Schlüssel mit dem Scope apps:write. Das Ersetzen einer bestehenden Custom Domain gibt den bisherigen Hostnamen am Edge frei, bevor der neue angebunden wird, es sei denn, eine andere Anwendung im selben Konto verweist noch darauf. Dieselbe Validierung läuft sowohl beim Anbinden als auch beim Entfernen (custom: "@"): Bei einer Workspace-geteilten Anwendung benötigt der Aufrufer im Workspace die Rolle admin oder muss Eigentümer sein. Eine Domain kann jeweils nur von einem Konto beansprucht werden: Das Anbinden eines Hostnamens, der bereits einem anderen Konto gehört, liefert DOMAIN_ALREADY_EXISTS. Um alle über deine Anwendungen konfigurierten Hostnamen zu sehen, siehe Domains auflisten. Rufe nach dem Anbinden die erforderlichen Validierungseinträge mit DNS-Einträge abrufen ab.

Parameter

string
erforderlich
Die ID der Anwendung. Du findest sie in der URL des Dashboards deiner Anwendung.
string
erforderlich
Die vollständig qualifizierte Domain, die angebunden werden soll, oder @, um die aktuelle Custom Domain der Anwendung zu entfernen. Es darf keine Square-Cloud-Domain sein (squareweb.app, squarecloud.app, …).

Antwort

string
Gibt an, ob der Aufruf erfolgreich war: success, wenn ja, error, wenn nicht.
Bei einem Fehler enthält die Antwort einen Fehler-code:

Siehe auch