Get All Preset IP Ranges Targetings

Get the list of all preset ip-ranges groups.

URL: /rest-api/preset-ip-ranges/ip-ranges/list.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.

Response sample:

200 OK
[{"id":1,"title":"Group1"},{"id":2,"title":"Group2"}, ... ]

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.

Create | Update Preset IP Ranges Group

Save new preset ip-ranges group or update old one, in case, if parameter 'id' provided.

URL: /rest-api/preset-ip-ranges/group/save.do
Method: POST
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – in case if groupId provided, but not found.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • groupId – group id (optional).
  • title – group title (required).

Delete Preset IP Ranges Group

Delete preset ip-ranges group.

URL: /rest-api/preset-ip-ranges/group/delete.do
Method: DELETE
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Group ID not found.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • groupId – group ID (required).

Delete Preset IP Ranges in the Group

Delete preset ip-ranges by group id.

URL: /rest-api/preset-ip-ranges/group/clear.do
Method: DELETE
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – group ID not found.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • groupId – group ID (required).

Get Preset IP Ranges By Group

Get preset ip-ranges for group.

URL: /rest-api/preset-ip-ranges/ip-range/all-by-group.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Group ID not found.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • groupId – group ID (required).

Add Preset IP Range Into Group

Add new preset ip-range for group.

URL: /rest-api/preset-ip-ranges/ip-range/add.do
Method: POST
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Group ID not found.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • groupId – group ID (required).
  • from – ip from value to add (required).
  • to – ip to value to add (required).

Delete Preset IP Range From Group

Delete preset ip-range by id.

URL: /rest-api/preset-ip-ranges/ip-range/delete.do
Method: DELETE
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Group ID not found.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • ipRangeId – ip-range id (required)

Upload IP Ranges to a Group from a File

Uploads IP Ranges to an existing Preset IP Ranges group from a CSV file.

URL: /rest-api/preset-ip-ranges/group/upload-ip-ranges.do
Method: POST
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not Found – Group ID not found.

Response sample:
200 OK

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.
  • file – file to parse.
  • groupId – group id (required).

Need more help?

Should you require any additional help with our solutions, do not hesitate to contact Epom technical support at support@epom.com. Our support managers are dedicated to resolving any issues and providing you with solutions and support if you face difficulties or have questions.