Skip to main content
Use the Lumos APIs to automate access management, enforce compliance, and build integrations. To get started, try one of the Lumos recipes.
Lumos API Hostname

​
Authentication

Lumos authenticates API requests using API keys. You will need to pass in a header to all requests to the Lumos API like this one.
Example cURL command
API Tokens inherit and retain the permissions of the user that created them.

​
Creating an API Token

  1. Go to the API Tokens page in the Lumos settings.
  2. Click “Add API Token.”
  3. Enter a Name and a Description.
  4. Click “Create API Token.”
Store your API token carefully. For security, Lumos shows the API Token only at creation time. All Lumos API Tokens are prefixed with lsk_.

​
Testing the API

You can test the API using the command line or an app such as Postman. To use Postman:
  1. In Postman, go to Import (or File → Import) and enter this URL: https://api.lumos.com/openapi.json. Postman will create a collection from the spec.
  2. Set Authorization to Bearer and use your API token as the value (in the collection or on individual requests).

​
Pagination

Many Lumos endpoints for listing data support paginated responses. These endpoints use page and size as query parameters to control pagination.
Example Paginated Request

​
Input Parameters

Input query parameters are as follows:

​
Output Fields

The output fields of paginated responses are as follows: