Get All Preset Domain Targetings

Get the list of all configured groups for Preset Domain Targeting.

URL: /rest-api/preset-domain/group/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.

Get Preset Domain Targetings for Group

Get the list of all configured Preset Domains for a group by its ID.

URL: /rest-api/preset-domain/domain/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.

Create | Update Preset Domain Group

Create Preset Domain group or update an existing group if ID is provided.

URL: /rest-api/preset-domain/group/save.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.
  • title – group title; required.

Upload Preset Domains to a Group from a File

Uploads Preset Domains to an existing Preset Domains group from a CSV file.

URL: /rest-api/preset-domain/group/upload-domains.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.
  • file – CSV file containing Preset Domains; required.

Delete Preset Domain Group

Deletes Preset Domain group by its ID.

URL: /rest-api/preset-domain/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.

Clear Preset Domains in the Group

Clears Preset Domain in the group.

URL: /rest-api/preset-domain/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.

Delete Preset Domain

Deletes Preset Domain by its ID.

URL: /rest-api/preset-domain/domain/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.
  • domainId – domain ID.

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.