Skip to main content
Skip table of contents

Endpoints

You 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 of asset data from current time period.

    • Asset_History. Table of asset data from historical time period.

    • User_Combine. Table of user data from current time period.

    • User_History. Table of user data from historical time period.

  • OutputFields. This field filters the fields to include from each record in the API response. If this field is empty, all fields from each record are included in the response.

  • Filter. This field filters the records included in the API response. If the filter is set as an empty list, all records from the target table will be returned.

Lucidum limits API access to the Lucidum database to no more than 10 queries per minute to avoid negative impact on the system.

Filters

Filters use the following format:

CODE
{“field”: “CPU_Cores”,

  “operator”: “>=”,

  “value”: 4}

where:

“field”: “<name of the field>”,

“operator”: “<comparison operator>”,

  “value”: <value>

You cannot filter on date/time fields in the Lucidum API.

Field type

Supported operator

Example

Number

>, <, =, >=, <=, !=

{“field”: “CPU_Cores”,

  “operator”: “>=”,

  “value”: 4}

Number

in

{“field”: “CPU_Cores”,

  “operator”: “in”,

  “value”: [4,8,16]}

String

=

{“field”: “Asset_Name”,

  “operator”: “=”,

  “value”: “ec2-1324”}

String

like

{“field”: “Asset_Name”,

  “operator”: “like”,

  “value”: “%abc%”}

String

in

{“field”: “Asset_Name”,

  “operator”: “in”,

  “value”: [“ec2-123”, “ec2-456”]}

Boolean

=

{“field”: “Is_Virtual”,

  “operator”: “=”,

  “value”: true}

List

contains

{“field”: “List_Users”,

  “operator”: “contains”,

  “value”: [“user1”, “user2”]}

List

not contains

{“field”: “List_Users”,

  “operator”: “not contains”,

  “value”: [“user1”, “user2”]}

Examples

For examples, see the chapter on examples.

JavaScript errors detected

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

If this problem persists, please contact our support.