Ein Traffic-Report-Abonnement erstellen¶

Note

Im Body muss mindestens eines der Attribute domains oder vhosts definiert sein.

Senden einer POST-Anfrage an den Endpunkt /report-subscriptions.

Beschreibung¶

Mit der Create-Subscription-Anfrage erstellen Sie ein neues Report-Abonnement.

Voraussetzungen¶

Werte der Anfrage: keine

Objekte: CreateSubscriptionVO

Anfrage¶

Um ein Report-Abonnement zu erstellen, müssen dem Pfad der Anfrage keine weiteren Informationen hinzugefügt werden.

Für eine detaillierte Spezifikation, welche Informationen zum Erstellen eines Traffic-Report-Abonnements erforderlich sind, muss im Body das Objekt CreateSubscriptionVO mit den folgenden Attributen definiert werden:

Attribut	Beschreibung	Werte
`name`	Der Name des Abonnements.	`string`
`domains`	Ein Array von Domainnamen, die in den Traffic-Report aufgenommen werden sollen. Das System erweitert jede Domain bei der Erstellung um ihre Subdomains.HinweisUm eine Domain mit allen ihren Virtual Hosts aufzunehmen, muss das Attribut `vhosts` leer sein.	`array[string]`
`vhosts`	Ein Array von Subdomainnamen, die in den Traffic-Report aufgenommen werden sollen.HinweisUm nur bestimmte Virtual Hosts aufzunehmen, kann das Attribut `domains` leer sein.	`array[string]`
`language`	Die Sprache der von diesem Abonnement erzeugten Reports.	`string`

Die folgenden Attribute sind optional:

Attribut	Beschreibung	Werte
`active`	Legt fest, ob das Abonnement aktiv ist. Standard: `true`.	`true` `false`
`comments`	Ein Kommentar für das Abonnement.	`string`

Das System gibt als Antwort das neue Abonnement-Objekt mit den Informationen zum erstellten Eintrag zurück.

Beispiel¶

Beispiel-Request-Body:

{
  "name": "string",
  "domains": [
    "string"
  ],
  "vhosts": [
    "string"
  ],
  "language": "string",
  "active": true,
  "comments": "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.