Listing all IP filter entries of a subdomain¶

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

Description¶

The List-IP-Filters request allows the user to request a list of all IP filter entries for a subdomain of the organisation.

Requirements¶

Values of the request: Domain-ID {domainId}, Subdomain name {vHostName}

Objects: none

Request¶

To request a list of all IP filter entries of a subdomain, the Domain-ID {domainId} and the Subdomain name {vHostName} need to be added to the path of the request.

As a result, the user gets one or more objects IpFilterVO with the requested information.

The object provides the following information:

Attributes	Description	Values
`value`	The values in the format of an IP address or CIDR notation for the IP filter.	Single IP address CIDR notation Range of IP addresses
`type`	The type of the IP filter entry.	`WHITELIST` `BLACKLIST` `WHITELIST_REQUEST_LIMITER`
`SubdomainName`	The name of the subdomain for which the IP filter entry is used.	`string`
`enabled`	The availability of the entry.	`true` `false`
`id`	The ID of the entry.	`integer`
`modified`	The last modification date in ISO 8601 format.	`string($date-time)`
`created`	The creation date in ISO 8601 format.	`string($date-time)`

Example¶

Example response:

[
  {
    "objectType": "string",
    "value": "string",
    "type": "string",
    "expireDate": "string",
    "subDomainName": "string",
    "id": 0,
    "modified": "string",
    "created": "string",
    "comment": "string",
    "enabled": true
  }
]

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.