Limited Introduction phase- Customers will be onboarded as space allows
Lumen Network Diagnostics APIs enable the use of Lumen’s internal triage logic to assist in isolating trouble points or identifying possible performance issues with Lumen services. API access allows use of this logic for customers to create their own UI or process flows that will use the Lumen next suggested actions to better understand the current state of a customer service. This document provides technical information that Lumen customers may use to access the Network Diagnostics APIs and interpret the responses, and error messages when interfacing with the APIs. It does not intend to provide technical training on the individual dispositions and how they are interpreted on networks.
Intended User (Target Audience)
The Network Diagnostics APIs are only for use by approved Lumen Customers. All of the Lumen customers who intend to use Network Diagnostics APIs should request access for API Marketplace and complete the required authentication and authorization prerequisites before accessing the APIs. The Network Diagnostics APIs and associated technology should be used by someone who is familiar with API interfaces, REST, and JSON.
Lumen Network Diagnostics APIs allow a Customer to directly call APIs from their own application instead of having to login to a Lumen system or front end application to get information. This should enable a more efficient process for self-diagnosing services, viewing connection statuses, and creating tickets from their own applications. The Network Diagnostics APIs are not intended to be used as a persistent state check on any or all services on a repetitive basis and is intended to be used in a flow process when a services issue is detected, expected, or has been previously reported and additional information is needed.
Quick Start Guide
Enroll in Network Diagnostics APIs. Currently in a limited introduction phase. Contact your account representative to enroll.
Register user and API Apps
Obtain API keys. Upon enrollment you will receive test credentials to access test environments, and production credentials will move to approved status.
Setup authorization. Using the Navigation bar go to Code Samples for sample code for setting up authorization.
Make your first call. Using the Navigation bar go to the Documentation/Specification section:
Click on the Authorize button and add your Test credentials.
Select the Network Diagnostics GET/service/summary API.
Click on the “Try it out” button.
Fill in the Parameters.
Click the Execute button to see the response.
Authentication / Authorization
Lumen supports the OAuth 2.0 client credentials authorization grant flow for external access by client-side applications.
Only existing Lumen customers can access Network Diagnostics APIs. Please contact your account manager to begin the enrollment process, or see the Support section for more information. Upon enrollment you will receive instructions on how to get started. Once your application is approved you can go to Using OAuth 2.0 for detailed steps on getting a Bearer token using basic authorization base64 encoding.
Access Base Credentials
Email address that grants you access to the developer portal and application registration