Assurance API

1.9.x
(0 reviews)

API Resources

The Assurance API allows you to:

  • Retrieve product instance details
  • Diagnose a fault
  • Log a fault
  • Manage faults
  • View and schedule appointments
  • View network events
  • Subscribe to receive notifications and status updates

The Assurance API includes the following resources:

Name / Description Verb HTTP method Resource
Get API version/Test API connectivity GET GET /version
Get Authorization Application information GET GET /authorization
Create a new diagnostic session POST POST /sessions
Retrieve a set of diagnostic sessions GET GET /sessions
Retrieve a diagnostic session GET GET /sessions/{sessionid}
Retrieve schedule details based on search criteria GET GET /sessions/{sessionid}/schedule
Submit a Schedule Reservation Request for the Diagnostic Session. POST POST /sessions/{sessionid}/reservations
Update the fault type for the diagnostic session POST POST /sessions/{sessionid}/faultType
Submit a problem report for the diagnostic session POST POST /sessions/{sessionid}/problemReport
Cancel a diagnostic session PUT PUT /sessions/{sessionid}/cancel
Create a diagnostic test run POST POST /sessions/{sessionid}/diagnostics
Retrieve a diagnostic test run GET GET /sessions/{sessionid}/diagnostics/{diagnosticidentifier}
Get Product Information GET GET /products/{productid}
Initiate a factory reset of RGW ONT POST POST /products/{productid}/factoryReset
Initiate a reboot of RGW ONT POST POST /products/{productid}/reboot
Get Wi-Fi Configuration associated to product GET GET /products/{productid}/wifi
Modify Wi-Fi Configuration associated to product PUT PUT /products/{productid}/wifi/{wifiPortIndex}
Reset wireless service details for a single wlan associated with a product POST POST /products/{productid}/wifi/{wifiPortIndex}/reset
Get WAN Configuration associated to product GET GET /products/{productid}/wan
Modify WAN Configuration associated to product PUT PUT /products/{productid}/wan
Get list of Voice profiles and voice port details associated to product GET GET /products/{productid}/voice
Modify Voice service details for a single Voice profile associated to product PUT PUT /products/{productid}/voice/{voiceProfileIndex}
Modify Voice service details for a single Voice port associated to product PUT PUT /products/{productid}/voice/{voiceProfileIndex}/voicePort/{voicePortIndex}
Get LAN port details associated to product GET GET /products/{productid}/lan/ethernetPorts
Modify LAN port details associated to product PUT PUT /products/{productid}/lan/ethernetPorts/{ethernetPortIndex}
Get LAN Static IP addresses associated to product GET GET /products/{productid}/lan/staticIps
Set LAN Static IP addresses associated to product PUT PUT /products/{productid}/lan/staticIps
Get LAN DHCP and IP configuration associated to product GET GET /products/{productid}/lan/dhcpIp
Set LAN DHCP and IP configuration associated to product PUT PUT /products/{productid}/lan/dhcpIp
Get hosts connected to associated product GET GET /products/{productid}/lan/hosts
Retrieve a set of problem reports GET GET /problemReport
Retrieve a problem report GET GET /problemReport/{problemnumber}
Amend a problem report PUT PUT /problemReport/{problemnumber}
Close a problem report POST POST /problemReport/{problemnumber}/close
Cancel a problem report POST POST /problemReport/{problemnumber}/cancel
Update a problem report POST POST /problemReport/{problemnumber}/update
Unlink a problem report from an event POST POST /problemReport/{problemnumber}/unlink
Retrieve an event GET GET /events/{event_id}
Retrieve event impacts GET GET /events/{event_id}/impact
Download Event Impacts GET GET /events/{event_id}/impactDownload
Get Tests GET GET /tests
Get a specific test GET GET /tests/testId
Get test images GET GET /tests/testId/images/{imageid}
Get subscription details GET GET /subscriptions
Create a new subscription POST POST /subscriptons
Reference a subscription GET GET /{subscriptionid}
Update a subscription PUT PUT /{subscriptionid}
Delete a subscription POST POST /subscriptions{subscriptionid}/delete
Deactivate a subscription POST POST /subscriptions{subscriptionid}/deactivate
Get notifications by channel GET GET /channels/{channelId}/notifications
Used to reference notification to retrieve information GET GET /channels/{channelId}/notifications/{notificationsid}

Reviews