| Field | Description |
|---|---|
| API family name | CPE Management |
| API family owner | Charter Communications |
| API family summary | Service enabling API for customer premises equipment (CPE) management. |
| Terms: - Service Site: A physical location serviced by an internet service provider. - Device: Hardware supplied by a service provider (CPE) to enable network access to a subscriber at a Service Site. - Isolated Network: One or more networks available on a Device that are logically separated and do not support inter-network communication between WiFi clients (Home Devices). |
|
| High-Level Scope - Reboot one or more Devices (scheduled and immediate). - List, create, modify, or delete WiFi Isolated Networks on one or more Devices. |
|
B2C Scope: The subscriber uses the API to manage their own Device supplied by a service provider, for example, through Home Assistant. - List or modify their main WiFi Isolated Network. - List, create, modify, or delete one or more secondary WiFi Isolated Networks for guest or IoT Home Devices. - Reboot their Device to recover from a faulty network state. |
|
B2B2C Scope: A subscriber delegates limited authorization to manage a secondary guest Isolated Network to a short-term rental app for guest stays. - Create temporary Isolated Networks for rental guests. - Automatic removal of Isolated Networks using an expiration period. - Assign guest networks to a subscriber's "default" Device, allowing the subscriber to benefit from the functionality without granting access to Service Site or Device resources. |
|
B2B2B2C Scope 1: A business with several properties (e.g., long-term rentals, hotels) using their service provider's Devices delegates authorization to manage the Devices and Isolated Networks to a third-party IT company. The property owner is the subscriber of the internet services, not the individual tenants. - List the various Service Sites, if consent is granted by the property owners, including the location address through additional consent to reconcile data sets when Service Site counts range from 100 to 10,000+. - List the Devices at each Service Site, if consent is granted by the property owners, including the hardware address through additional consent to reconcile data sets when Device counts range from 100 to 10,000+. - Reboot Devices to recover from a faulty network state. - List, create, modify, or delete primary and secondary Isolated Networks. - Deploy the same Isolated Network to multiple Devices for coverage in common areas. |
|
| B2B2B2C Scope 2: The same scenario as the previous, except the tenants are the internet subscriber. - Mirror the previous use cases, but require consent from each and every tenant through granular OAuth scopes. - Set a description on resources, allowing tenants to label their Devices as an alternative to exposing hardware addresses when multiple Devices are present. |
|
| [!IMPORTANT] When designing this API, it was intended that third-parties must provide a justification during API client registration to request scopes for sensitive information, such as Service Site location addresses or Device hardware addresses, due to their protected status by many governments. A short-term rental app would be unlikely to have the ability to request those scopes from a subscriber in order to protect the subscriber's privacy against apps that request excessive permissions for data collection purposes. |
|
| Technical viability | This API requires remote management of CPE Devices for all management features (e.g., TR-069, TR-369, OVSDB, SNMP, etc.).This API definition is agnostic to the network isolation technique (e.g., separate Layer 3 networks, VLANs, OpenFlow, etc.). |
| Commercial viability | TR-069: RUCKUS Networks (commercial cloud), prpl (open source Device firmware)OVSDB: Plume (commercial cloud), OpenSync (partially open source Device firmware with commercial modules by Plume) |
| YAML code available? | YES - yaml - GitHub - yaml - Swagger Editor - slides - GitHub |
| Validated in lab/productive environments? | YES - Field deployed on the production network using a UAT cloud with a production launch slated for the end of Q2. |
| Validated with real customers? | In-progress for B2B2B2C Scope 1 & 2 with Charter, 1x API client, and 1x subscriber that has 30,000 properties. Some of the properties have the property owner as the subscriber and others the tenant is the subscriber. Charter is actively looking for a B2B2C API client partner. |
| Validated with operators? | Liberty Global, Vodafone, VodafoneZiggo, Charter, CableLabs |
| Supporters in API Backlog Working Group | Liberty Global, Vodafone, VodafoneZiggo, Charter, CableLabs |