To further improve our DNA Enterprise product, we released a new feature that will help customers to better handle the traffic inside their corporate networks, and avoid inter-site data transfers.

The Streamroot Subnets API allows you to create, read, update and delete sites. Sites are groups of users forming a mesh network that only exchange video data within itself. With well-defined sites, no video data will be transferred from one site to another ensuring that each sites upload bandwidth is not used, and that download bandwidth is only used to get content from the CDN for a small fraction of users.

A site is composed of:

• a name which must be unique and matching the following regexp:  ^[a-zA-Z0-9_ \\(\\)-]{1,64}$
• a list of public IPs (IPv4 or IPv6)
• a list of subnets (IPv4 or IPv6)

All endpoints are only accessible via HTTPS and take/return JSON payloads.

Enabling Subnets

A new property has been added for DNA Enterprise customers: Subnet matching. This will need to be toggled ON to add subnets to Streamroot. Properties are a way to fine-tune various parameters across all your Streamroot DNA integrations and can be accessed under the “Properties” section in the dashboard. See our documentation for more information on them.

Types

{ 
  "name": "Name",
  "publicIPs": "[CIDR]",
  "subnets": "[CIDR]"
}

{
  "name": "foobar (dummy-42)",
  "publicIPs": [
    "35.0.0.0/30",
    "36.0.0.0/30"
  ],
  "subnets": [
    "10.0.0.0/29",
    "192.168.0.0/29"
  ]
}

Authentication

Authentication is required before using our APIs. Please refer to this article to learn how to authenticate.

End Points

Create Sites - The given sites will be added to your existing ones.

Replace Sites - Your existing sites will be deleted and replaced by the given ones.

List Sites - Show a list of all active Sites.

Update Sites - The given Sites will be updated to display the new values.

Delete Sites - The site will be deleted permanently.

Create Sites

The API provides two endpoints to create sites, with different behaviors:

• Append: the given sites will be added to your existing ones.
• Replace: your existing sites will be deleted and replaced by the given ones.

Append

The given sites will be added to your existing ones.

POST https://apiv2.streamroot.io/subnetMatcher/customerSiteId

Headers

Request

A list of Site: [Site]

[
  {
    "name": "Name",
    "publicIPs": [
      "<CIDR>"
    ],
    "subnets": [
      "<CIDR>"
    ]
  }
]

[
  {
    "name": "Tokyo",
    "publicIPs": [
      "35.0.0.0/32"
    ],
    "subnets": [
      "192.168.0.0/16"
    ]
  },
  {
    "name": "Denver",
    "publicIPs": [
      "36.37.0.0/30"
    ],
    "subnets": [
      "192.168.1.0/24"
    ]
  }
]

 Response

Success

 A JSON object of the following form:

{
 "success": [Site],
 "errors": {
 "name": <Name>,
 "message": string
 }
}

{
  "success":
    {
      "id": "5c0feb1457bf480001c244b5",
      "name": "Tokyo",
      "publicIPs": [
        "23.0.0.0/32"
      ],
      "subnets": [
        "192.168.0.0/30"
      ]
    }
}

 Errors

Our API returns success or error status codes. For errors, we include information encoded in the JSON response about what went wrong. The various errors that can be returned are listed below.

{
  "error": string
}

{

  "error": "site 'Tokyo': already exists"

}

{
  "error": string
}

{
  "error": "site 'Denver': in conflict with site 'Rio'"
}

{
  "error": string
}

{
  "error": "site 'Nairobi': publicIPs is empty"
}

{
  "error": string
}

{
   "error": "malformatted JSON"
}

Replace

Your existing sites will be deleted and replaced by the given ones.

PUT https://apiv2.streamroot.io/subnetMatcher/customerSiteId

Headers

Request

A list of Site: [Site]

[
  {
    "name": "Name",
    "publicIPs": [
      "<CIDR>"
    ],
    "subnets": [
      "<CIDR>"
    ]
  }
]

[
  {
    "name": "Tokyo",
    "publicIPs": [
      "35.0.0.0/32"
    ],
    "subnets": [
      "192.168.0.0/30"
    ]
  },
  {
    "name": "Denver",
    "publicIPs": [
      "36.37.0.0/30"
    ],
    "subnets": [
      "192.168.1.0/24"
    ]
  }]

 Response

Success

Our API returns success status codes. 

Errors

For errors, we include information encoded in the JSON response about what went wrong. The various statuses that can be returned are listed below. 

{
  "error": string
}

{
  "error": "site 'Tokyo': already exists"
}

{
  "error": string
}

{
  "error": "site 'Denver': in conflict with site 'Rio'"
}

{
  "error": string
}

{
  "error": "site 'Nairobi': publicIPs is empty"
}

{
  "error": string
}

{
   "error": "malformatted JSON"
}

List Sites

Shows a list of all Sites active in Streamroot.

GET https://apiv2.streamroot.io/subnetMatcher/customerSiteId

 Response

 A JSON object of the following form:

[<Site>]

[
  {
    "id": "5c0feb1457bf480001",
    "name": "Tokyo",
    "publicIPs": [
      "112.0.0.0/32"
    ],
    "subnets": [
      "192.168.0.0/30"
    ]
  }
]

Update Sites 

The given sites will be updated to display the new values. Only one site can be updated at a time.

PUT https://apiv2.streamroot.io/subnetMatcher/customerSiteId/{ID}

Headers

Request

A list of Site: [Site]

{
  "name": "Name",
  "publicIPs": [
    "<CIDR>"
  ],
  "subnets": [
    "<CIDR>"
  ]
}

{
  "name": "Tokyo",
  "publicIPs": [
    "35.0.0.0/32"
  ],
  "subnets": [
    "192.168.0.0/30"
  ]
}

 Response

Success

 A JSON object of the following form:

<Site>

{
  "id": "5c0feb1457bf480001",
  "name": "Tokyo",
  "publicIPs": [
    "112.0.0.0/32"
  ],
  "subnets": [
    "192.168.0.0/30"
  ]
}

Errors

Our API returns success or error status codes. For errors, we include information encoded in the JSON response about what went wrong. The various errors that can be returned are listed below.

{
  "error": string
}

{
  "error": "already exists"
}

{
  "error": string
}

{
  "error": "publicIPs is empty"
}

{
  "error": string
}

{
  "error": "invalid CIDR address: /32"
}

{
  "error": string
}

{
   "error": "malformatted JSON"
}

{
  "error": string
}

 {
  "error": "not found"
}

{
  "error": string
}

{
  "error": "conflict with site Rio"
}

Delete Sites

The site will be deleted permanently.

DELETE https://apiv2.streamroot.io/subnetMatcher/customerSiteId/{ID}

Headers

Response

Success

Our API returns success or error status codes.

Errors

For errors, we include information encoded in the JSON response about what went wrong. The various statuses that can be returned are listed below.

{
  "error": string
}

{
  "error": "not found"
}