Exporting all IP filter entries of a subdomain as CSV¶
Note
The response is a plain CSV file, not a JSON payload.
Sends a GET request to the endpoint /domain/{domainId}/ip-filters/{vHostName}/export.
Description¶
The Export-IP-Filters-Request request exports all IP filter entries of a subdomain of the organisation as a CSV file.
Requirements¶
Values of the request: Domain-ID {domainId}, Subdomain name {vHostName}
Objects: none
Request¶
To export all IP filter entries of a subdomain, add the Domain-ID {domainId} and the Subdomain name {vHostName} to the path of the request. The request supports the following optional query parameter:
| Attributes | Description | Values |
|---|---|---|
type |
Filters the exported entries by IP filter type. |
|
The body of the response is not a JSON object but a CSV file (Content-Type: text/csv). The first line is the header IP,Expires on,Comments. Each following line contains an IP filter entry with the following comma-separated columns:
| Attributes | Description | Values |
|---|---|---|
IP |
The value of the IP filter entry in the format of an IP address or CIDR notation. | string |
Expires on |
The expiry date of the entry in ISO 8601 format (Y-m-d\TH:i:sP), empty if the entry does not expire. |
string($date-time) |
Comments |
The comment saved for the entry. | string |
Responses¶
The following responses are available:
| STATUS CODE | DESCRIPTION |
|---|---|
| 200 | The request has succeeded. |
| 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. |
| 404 | The request was unsuccessful because the requested resource was not found. |