Changing a traffic report subscription¶

Note

The body must include the attributes id and modified to identify the corresponding entry.

Note

At least one attribute domains or vhosts must be defined in the body.

Sends a PUT request to the endpoint /report-subscriptions/{id}.

Description¶

The Change-Subscription request allows the user to change the settings of a traffic report subscription.

Requirements¶

Values of the request: Subscription-ID {id}d}

Objects: UpdateSubscriptionVO

Request¶

To change a traffic report subscription, the Subscription-ID {id} needs to be added to the path of the request.

For a detailed specification of which information is required to change a traffic report subscription, the object UpdateSubscriptionVO with the following attributes needs to be defined in the body:

Attributes	Description	Values
`id`	The ID of the subscription.	`integer`
`modified`	The last modification date of the subscription in ISO 8601 format.	`string($date-time)`

The following attributes are optional. Specify only the attributes that are to be changed. Omit all attributes that are to remain unchanged:

Attributes	Description	Values
`name`	The name of the subscription.	`string`
`domains`	An array of domain names to be included in the traffic report. The system extends each domain with its subdomains during creation.NoteTo include a domain with all its virtual hosts, the attribute `vhosts` must be empty.	`array[string]`
`vhosts`	An array of subdomain names to include in the traffic report.NoteTo include only specific virtual hosts, the attribute `domains` can be empty.	`array[string]`
`language`	The language of the reports generated by this subscription.	`string`
`active`	Defines whether the subscription is active.	`true` `false`
`comments`	A comment for the subscription.	`string`

The system responds by returning the updated subscription object.

Example¶

Example request body:

{
  "name": "string",
  "domains": [
    "string"
  ],
  "vhosts": [
    "string"
  ],
  "language": "string",
  "active": true,
  "comments": "string"
}

Responses¶

The following responses are available:

STATUS CODE	DESCRIPTION
200	The request has succeeded.
400	The request was unsuccessful. The request was invalid or information is missing.
401	The request has not succeeded because the user authentication was incorrect.
403	The request has not succeeded because the user does not have the right permissions.