Skip to main content
Skip table of contents

Overview of Lucidum API v2

Lucidum 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 page or Edit Query page when you click on the Field field (Explore button > Query Builder page> New Query/Edit Query page > Field field). The response includes a description of each field and its data type.

  • Retrieve the List of Fields for Users (/CMDB/v2/data/metadata/user). The response includes the same list of fields for a user that you see in the New Query page or Edit Query page when you click on the Field field (Explore button > Query Builder page> New Query/Edit Query page > Field field). The response includes a description of each field and its data type.

  • Query the Lucidum Database (/CMDB/v2/data/cmdb). Query Lucidum using fields, operators, AND statements, and OR statements, as you would in the Query Builder in the Lucidum UI.

  • Retrieve a record of changes to an asset or user (/CMDB/v2/data/metadata/cmdb/asset/change and /CMDB/v2/data/metadata/cmdb/user/change). This endpoint retrieves all the changed fields for a single asset or a single user. For each changed field, the endpoint also retrieves the date and time associated with each change, the old value, and the new value.

  • Retrieve metrics about users and assets (/CMDB/v2/system/metrics/data). This endpoint allows you to query Lucidum for metrics about users and assets, specifically:

    • number of assets

    • number of users

    • 30-day average number of assets

    • 30-day average number of users

  • Query the Lucidum Database about Licensing (/CMDB/v2/system/metrics/license). This endpoint allows you to query Lucidum for licensing information.

  • Query the Lucidum Database about Connector Data (/CMDB/v2/system/metrics/connector). This endpoint allows you to query Lucidum and get a list of each connector used by Lucidum and the data retrieved by each connector.

  • Query the Lucidum Database about Ingestion Jobs (/CMDB/v2/system/metrics/data-ingestion). This endpoint allows you to query Lucidum for a list of data ingestion job. The response lists each job, its start time, end time, and status.

  • Query the Lucidum Database about the Next Ingestion Job (/CMDB/v2/system/metrics/data-ingestion/next). This endpoint allows you to query Lucidum for information about the next data ingestion job. The response tells when the next ingestion job will run and the scheduled interval.

  • Query the Lucidum Database for Details about Ingestion Job by Date and Time (/CMDB/v2/system/metrics/data-ingestion/details). This endpoint allows you to query Lucidum for details about a specific data ingestion job.

  • Query the Lucidum Database for Details about Scheduled Action Jobs (/CMDB/v2/system/metrics/actions). Lucidum automatically executes Actions at the time and recurrence defined in the action. This endpoint allows you to query Lucidum for details about all Actions jobs that have been scheduled.

  • Query the Lucidum Database for Details about a Single Scheduled Action Job ( /CMDB/v2/system/metrics/action-jobs/action_id). Lucidum automatically executes Actions at the time and recurrence defined in the action. This endpoint allows you to query Lucidum for details about all the scheduled jobs for a specific action..

To use the endpoints, you append the URL of your Lucidum server to the endpoint.

For example, to query the Lucidum database about assets and users, the full endpoint is:

CODE
https://<URL of your Lucidum server>/CMDB/v2/data/cmdb

For example:

CODE
https://Company.Lucidum.cloud/CMDB/v2/data/cmdb 

Queries

API Requests to query the Lucidum database (/CMDB/v2/data/cmdb) includes logic for:

  • Finding fields

  • Specifying operators

  • Specifying field values

  • AND statements

  • OR statements

Methods

The Lucidum API v2 supports the following methods:

  • GET the list of all possible fields and their descriptions (endpoint “/CMDB/v2/data/metadata/asset” or /v2/data/metadata/user”)

  • POST to send queries to the Lucidum database (endpoint “/CMDB/v2/data/cmdb”)

  • GET metrics about assets, ingestion, and actions (endpoint “/CMDB/v2/system/metrics/”)

  • GET metrics about changes to user records and asset records (endpoints “CMDB/v2/data/metadata/cmdb/asset/change” and “/CMDB/v2/data/metadata/cmdb/user/change”)

The Lucidum API requires a POST method to query the Lucidum databases.

Caveats

  • Lucidum does not support SSO access for the Lucidum API.

  • Lucidum limits API v2 access to Lucidum to no more than 60 queries per minute to avoid negative impact on the Lucidum system.

  • The endpoints for the Lucidum APIs are case-sensitive.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.