Page optimized for desktop experience. Please use a desktop browser for best compatibility.

Create a Zone

Create a new Zone in Rev and assign Devices as needed.

POST
/api/v2/zones

Request Body

application/json

{
  "Name":"New York HQ",
  "supportsMulticast":true,
  "IpAdresses":[
  "11.11.111.12"
  ],
  "IpAddressRanges":[
    {
    "start":"192.168.0.0",
    "end":"192.168.255.255"
    }
  ],
  "targetDevices":[
    {
    "deviceId":"be19ffa2-a919-42fc-abd2-cd4ec0d6c31d",
    "deviceType":"Custom",
    "isActive":true,
    "liveOnly":true,
    "streams":[
      "StreamName1",
      "StreamName2"
      ]
    }
  ]
}

revConnectSetting if revConnectEnabled = true

{
  "disableFallback": true,
  "maxZoneMeshes": 0,
  "groupPeersByZoneIPAddresses": true
}

 

Parameter Type Validations
name string, required Zone name. Must be a unique name within the Rev account.
supportsMulticast string, optional true / false
ipAdresses [ ] array, optional Individual IP addresses added to the zone.
ipAddressRanges [ ] array, optional

IP address ranges

  • start = starting IP address for the range
  • end = ending IP address for the range
targetDevices [ ] array, required
  • deviceId = the device (e.g. DME)
  • deviceType = Custom / Encoder / Dme / Akamai
  • isActive = true / false
  • liveOnly = true / false (specifies no VOD videos retrieved if true)
  • streamname(s) = Rev entered names for the streams added to the zone from this specific device
overrideAccountSlideDelay boolean, optional True/false. Flag to override the account slide delay settings.
slideDelaySeconds integer, optional The slide delay in seconds.
revConnectEnabled boolean, optional True/false. Only available if zone includes Rev Connect support.
revConnectSetting {  } object, optional

Available when a Rev Connect zone is enabled. Parameters include:

  • disableFallback: true/false; disables fallback to a unicast stream (if available) which means the zone will only support multicast or Rev Connect.
  • maxZoneMeshes: 0; defines the upper limit of what can be used within the zone based on licensing retrictions.
  • groupPeersByZoneIpAddresses: true/false

Response Messages

successful response

{ “zoneId”: “5e7f4998-6fcf-4809-b82d-bbb6d1ad74e9” }

Unauthorized error

Internal server error