APIs tab topics

Use Lumen Connect℠ to create and manage API keys for your organization so you can access Lumen network and data APIs. Once you explore our APIs, you can register for API access and then create API keys.

Jump to a topic

Need access to manage API keys?

Register for API access

Get help registering

Need access to manage API keys?

Get help registering

API keys

Use API keys to generate a client ID and client secret so your organization can communicate with Lumen using APIs.

API keys

Use API keys to generate a client ID and client secret so your organization can communicate with Lumen using APIs.

Cipher suites

As part of our commitment to a fast and secure network, we have retired older, weaker cipher suites. These updates align with industry-standard recommendations.
 

  • A cipher suite is a combination of algorithms that work together to secure communications over the network.

  • While the cipher suite is not part of the API call, it is part of the HTTPS connection which APIs use.
     

If you don't support one of the approved cipher suites, make any corresponding TLS (transport layer security) changes.

OpenSSL cipher suite nameTLS version
TLS_AES_128_GCM_SHA256TLSv1.3
TLS_AES_256_GCM_SHA384TLSv1.3
TLS_CHACHA20_POLY1305_SHA256TLSv1.3
ECDHE-ECDSA-AES128-GCM-SHA256TLSv1.2
ECDHE-RSA-AES128-GCM-SHA256TLSv1.2
ECDHE-ECDSA-AES256-GCM-SHA384TLSv1.2
ECDHE-RSA-AES256-GCM-SHA384TLSv1.2
ECDHE-ECDSA-CHACHA20-POLY1305TLSv1.2
ECDHE-RSA-CHACHA20-POLY1305TLSv1.2
DHE-RSA-AES128-GCM-SHA256TLSv1.2
DHE-RSA-AES256-GCM-SHA384TLSv1.2
DHE-RSA-CHACHA20-POLY1305TLSv1.2

  • "TLS handshake failed"

  • "SSL connection error"

  • "The underlying connection was closed"

  • "Could not create SSL/TLS secure channel"

  • "Connection reset by peer"

  • "Protocol version not supported"

API credentials

Effective April 26, 2026, we will no longer accept non-expiring API keys or API keys that don't contain special characters. If you use either of these, you must create a new API key using Lumen Connect. (If you don't have access to Lumen Connect to manage API keys, you can request access. Get help registering)
 

  • Example old API client key (requires new API key): abc1defghiJklm2NOPqrstuvwxyz
  • Example new API client key: abc1D-EFgHoJ2kl-mnOPQRs-tuv-W3xYZaBCDeFG

API authentication endpoints

Effective April 26, 2026, update your API authentication endpoints to use the following authentication:
 

  • Test: https://api-test.lumen.com/oauth/v2/token
  • Production: https://api.lumen.com/oauth/v2/token

Frequently asked questions

How do I access a production environment?

Request access to the API for your application in Lumen Connect. Select production as the environment for your credentials. After the request is authorized, you can access the production API key.

How do I access a sandbox environment?

First, create a sandbox API key using Lumen Connect. After the request is authorized, use the consumer key and client secret credentials to access the sandbox API products.

How do I create a user account?

To create a user account, register for API access.

How do I obtain a consumer key and client secret?

When you create an API key in Lumen Connect, you receive a consumer key and client secret. After your API key is approved, your consumer key and client secret are activated and you can call the Lumen authorization server to request an access token.

Do my original apps expire?

Your original apps do not have a set expiration date. However, we recommend creating a new API key to enable full editing access. After February 18, 2026, we will no longer accept non-expiring API keys.

What if I misplaced my client secret for an original app?

If you misplace or need to change a client secret, you can reset the client secret for the API key using Lumen Connect.

How do I obtain user credentials?

To work with Lumen APIs, register for API access. Once you have access, you can then create and manage API keys using Lumen Connect.

How do I register an application?

With API keys, you can register multiple applications under the same user account.

How do I sample an API?

You can test endpoints using mock data with the “Try It Out” function in our API documentation. When you are ready to start developing and want to test the API, create an API key to access the API product.

What’s the difference between sandbox and production environments?

Sandbox (also known as test) keys establish credentials to a sandbox environment for all API products in your sandbox app. Production environments establish credentials for all API products in your production app.

Hide

How does versioning work?

Lumen APIs use semantic versioning for releases as development continues. Major versions, updates, and patches are indicated in the API URL. For example, version 2.3.1 is the second major version with three updates and one minor patch.

What API products are available?

Learn more about all of our available API products with in‑depth user guides and interactive endpoint documentation. If you do not find something you need, contact us and provide feedback.

Hide

How secure is Lumen Connect?

Lumen prioritizes security. We use multiple layers of protection to keep your accounts and data safe including HTTPS and the OAuth 2.0 model for authentication and authorization.

How is OAuth 2.0 used in Lumen Connect?

Lumen API products use the OAuth 2.0 protocol for authorization. Lumen supports the OAuth 2.0 client credentials grant type flow for external access by applications. First, you obtain your OAuth 2.0 client credentials from Lumen Connect. Then, your client application will request an access token from the Lumen authorization server. Extract the access token from the response and send the token as a bearer token to the Lumen API endpoint that you want to access. To learn more, refer to Using OAuth 2.0.

What is OAuth 2.0?

The OAuth 2.0 authorization framework enables a third‑party application to obtain limited access to an HTTP service. Access is granted either by a resource owner orchestrating an approval interaction between themself and the HTTP service or by allowing the third‑party application to obtain access on its own behalf. This specification replaces the OAuth 1.0 protocol described in RFC 5849. Learn more about OAuth 2.0

Hide

How do I ask for help?

We’re here to help! Click Contact Us on any page of Lumen Connect, and you will be prompted to fill out a webform that will be routed to our support team. If you have access to Lumen Connect, you can also use chat within the portal.

How do I sign up for push notifications?

Sign up for push notifications in Lumen Connect to stay up‑to‑date on scheduled maintenances and repair tickets.

How long are API versions supported?

We continually update our API inventory by adding new solutions or introducing new versions of existing APIs. Before we discontinue support for an API version, we will always communicate our plans well in advance.

What are the supported browsers for Lumen Connect?

Learn more about what browsers we support

Hide