Enable Rules

Enable Rules for Site.

URL: /rest-api/rules/site/{siteId}/enable.do

Method: GET

Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 – permission violation.
  • 400 Not Found – no Site with such ID.

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 for hash generation.
  • username – a given username.
  • siteId – Site identifier.

Disable Rules

Disable Rules for Site.

URL: /rest-api/rules/site/{siteId}/disable.do

Method: GET

Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 – permission violation.
  • 400 Not Found – no Site with such ID.

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 for hash generation.
  • username – a given username.
  • siteId – Site identifier.

Add new Rule group

Adds new Rule group for Site.

URL: /rest-api/rules/site/{siteId}/add.do

Method: GET

Response format: application/json

Error codes:

  • 400 Bad Request – empty rule IDs parameter.
  • 401 Unauthorized – authentication error.
  • 403 – permission violation.
  • 400 Not Found – no Site with such ID.

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 for hash generation.
  • username – a given username.
  • siteId – Site identifier.
  • ruleIds – array of rules identifier.
  • include – true if Rule should be included; false if Rule should be excluded.
  • operator – AND/OR operator.

Remove new Rule group

Removes Rule group from Site.

URL: /rest-api/rules/site/{siteId}/remove.do

Method: GET

Response format: application/json

Error codes:

  • 400 Bad Request – empty ruleIds parameter.
  • 401 Unauthorized – authentication error.
  • 403 – permission violation.
  • 400 Not Found – no Site with such ID.

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 for hash generation.
  • username – a given username.
  • siteId – Site identifier.
  • ruleGroupId – identifier of Rule group.

Return Rule groups

Returns all Rule groups for Site.

URL: /rest-api/rules/site/{siteId}/GET.do

Method: GET

Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 – permission violation.
  • 400 Not Found – no Site with such ID.

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 for hash generation.
  • username – a given username.
  • siteId – Site identifier.

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.