Create | Update Zone

Creates or updates Zone based on whether Zone ID was provided.

URL: /rest-api/zones/update.do

Method: POST

Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.

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.
  • name – Zone name.
  • description – a short Zone description.
  • siteId – ID of Site where to create new Zone.
  • id – Zone ID.

Delete Zone

Deletes Zone with a given ID.

URL: /rest-api/zones/{zoneId}/delete.do

Method: POST

Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.

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.

Get Zone

Return zone properties by given id.

URL: /rest-api/zones/{zoneId}.do

Method: GET

Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 404 Not Found – zone with given id was not found/ does not exists.

Response sample:
200 OK


{"name":"zName", "hasTraffic":false, "active":false,"description":"zDescr"} - success
{"permission_denied":"access forbidden for zone[{zoneId]"} - failure due to insufficient privileges
{"Not Found": "Zone[{zoneId}] does not exists"} - not found case

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.

Get Placements of the Zone

Returns the list of all Placements for a given Zone.

URL: /rest-api/zones/{zoneId}/placements.do

Method: GET

Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.

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.

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.