kate-gibson
Authentication
Last Updated: July 15, 2024You use the Lucidum API to authenticate API access. This chapter explains the authentication endpoint. Authentication: /v1/access_token The endpoint to authenticate for API access is /v1/access_token. Endpoint Method Parameters in Request Body /v1/access_token. POST clientID. The Client ID for your Lucidum account. See the section on Authorization Tokens to generate this value. secret. The Secret...
Tokens, Response Codes, Pagination, Methods, Caveats
Last Updated: September 26, 2025Lucidum includes query-based APIs for accessing the Lucidum database and the Lab database. This document describes how to use the Lucidum APIs. Authorization Tokens There are three tokens for accessing the Lucidum API. You can generate all three tokens from the Lucidum UI. Lucidum does not support SSO access for the Lucidum API. Basic authorization...
Endpoints
Last Updated: July 15, 2024You can use the Lucidum API to: Query the Lucidum database tables (/v1/data/cmdb) The following sections describe the endpoints for these actions. Query the Lucidum Database: /v1/data/cmdb The endpoint for querying the Lucidum database is /v1/data/cmdb. Endpoint Method Parameters in Request Body /v1/data/cmdb POST CollectionName. The Lucidum database table to query. Choices are: AWS_CMDB_Output. Table...
Examples
Last Updated: February 9, 2026Retrieve All Values from the Lucidum Database We could use the following cURL request to retrieve all values from the database table that contains asset data from current time period. This request is helpful to determine which fields are available. After you know which fields are available, you can use the outputFields parameter and the...
Overview of Lucidum API v2
Last Updated: June 25, 2025Lucidum includes query-based APIs for accessing the Lucidum Query Builder. This document describes how to use the Lucidum APIs v2. Endpoints The Lucidum API v2 includes the following endpoints: Retrieve the List of Fields for Assets (/CMDB/v2/data/metadata/asset). The response includes the same list of fields for an asset that you see in the New Query...
Authentication in API v2
Last Updated: September 29, 2025This chapter describes how to authenticate with the Lucidum API v2. The steps are: Generate a bearer token Include the bearer token in the header of each API request Generating a Bearer Token for /CMDB/v2/data/ldg Endpoint The /CMDB/v2/data/ldg endpoint retrieves only enriched data from the Lucidum Data Group. This endpoint provides a more focused set...
Endpoints for Assets and Users
Last Updated: January 8, 2026You can use the Lucidum API to: Retrieve a list of available fields with a description and data type for each field Query Lucidum as you would from the Lucidum Query Builder, including using OR and AND statements The following sections describe the endpoints for these actions. Headers Requests to the endpoints in the Lucidum...
Endpoints for Change Management
Last Updated: June 25, 2025You can use the Lucidum API to: Retrieve a list of changes for a single asset or a single user with a description and data type for each field, the date of change, the old value, and the new value. Query Lucidum as you would from the Lucidum Query Builder, including using OR and AND...
Endpoints for System Metrics
Last Updated: April 10, 2025You can use the Lucidum API to query Lucidum about: the number of assets and the number of users the current license and its expiration date all active Connectors data ingestion jobs Action jobs The following sections describe the endpoints for these actions. Headers Requests to the endpoints in the Lucidum API v2 must also...
Pagination
Last Updated: July 15, 2024The Lucidum APIs can return multiple pages in a response. Lucidum recommends that you specify a page to return and the number of records to include in the page. Pagination Syntax To define pagination, include the following in the request body. "paging": { "page": 0, "recordsPerPage": 20 } “paging”:{. Specifies that that section between the...