Importing IP filter entries for a subdomain from a CSV payload¶

Note

The request body is a plain CSV payload, not a JSON payload. Lines that cannot be parsed as a valid IP address or a valid CIDR range are rejected and returned as a validation error.

Sends a POST request to the endpoint /domain/{domainId}/ip-filters/{vHostName}/import.

Description¶

The Import-IP-Filter request imports IP filter entries for a subdomain of the organisation as a bulk import from a plain CSV payload.

Requirements¶

Values of the request: Domain-ID {domainId}, Subdomain name {vHostName}, type (query parameter)

Objects: none

Request¶

To import IP filter entries for a subdomain, add the Domain-ID {domainId} and the Subdomain name {vHostName} to the path of the request. The query parameter type is required and defines the IP filter type applied to each imported entry.

Attributes	Description	Values
`type`	The IP filter type applied to all imported entries. Required query parameter.	`ALLOWLIST` `WHITELIST` `BLACKLIST` `BLOCKLIST` `ALLOWLIST_REQUEST_LIMITER` `WHITELIST_REQUEST_LIMITER`

The request body is not a JSON object but plain CSV content. Each line represents an IP filter entry with the following comma-separated columns. An entry with the same value and type as an existing entry updates that entry instead of creating a duplicate:

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 (for example `yyyy-mm-ddThh:mm:ss+hhmm`), 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
201	The request has succeeded and a new object has been created.
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.
404	The request was unsuccessful because the requested resource was not found.