Endpoints for SmartLabels

You can use the Lucidum API to:

• Search the list of SmartLabels by SmartLabel name and retrieve the SmartLabel ID, LLM Description, and LLM Business Value

• Retrieve details about a SmartLabel

The following sections describe the endpoints for these actions.

Headers #

Requests to the endpoints in the Lucidum API v2 must also include a header with:

• Content-Type of JSON.

• bearer Token we generated in the Edit User page.

Retrieve Information about One, Multiple, or All SmartLabels: CMBD/v2/smartlabel/search #

This endpoint queries Lucidum for the list of all connectors. This endpoint returns:

• an entry for each specified SmartLabel

• each entry includes:

  • the SmartLabel ID

  • the LLM Description

  • the LLM Business Value

cURL Example for CMBD/v2/smartlabel/search #

curl --location 'https://dogfood.lucidum.cloud/CMDB/v2/smartlabel/search' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer wKxfYgclDAvzIlsvUevU' \
--data '{
   "smartLabels": [
      "Assets_with_Users_KATE_SmartLabel",
      "Encryption_Flag_Linux_2_SmartLabel"
   ]
}'\'''

This example returns:
[
   {
      "id": "682b8c762ff0c4343154bf61",
      "field_collection": "AWS_CMDB_Output",
      "field_name": "Assets_with_Users_KATE_SmartLabel",
      "friendly_name": "Assets with Users KATE",
      "field_type": "Boolean",
      "llmDescription": "This smart label identifies asset records that have a associated Lucidum User Name.",
      "llmBusinessValue": "This smart label helps in identifying assets managed by specific users, which can be useful for accountability and access management."
   },
   {
      "id": "68ae117a05b481201589049c",
      "field_collection": "AWS_CMDB_Output",
      "field_name": "Encryption_Flag_Linux_2_SmartLabel",
      "friendly_name": "Encryption Flag Linux 2",
      "field_type": "Integer",
      "llmDescription": "This smart label identifies Linux assets that have encryption enabled.",
      "llmBusinessValue": "This smart label helps in understanding which Linux-based devices have encryption active, aiding in assessing the security posture and compliance with data protection policies."
   }
]

cURL Example 2 for CMBD/v2/smartlabel/search #

To retrieve entries for all SmartLabels, supply an empty list of SmartLabel names:

curl --location 'https://dogfood.lucidum.cloud/CMDB/v2/smartlabel/search' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer wKxfYgclDAvzIlsvUevU' \
--data '{
"smartLabels": [
]
}'\'''

Retrieve Information about One or More SmartLabels: CMBD/v2/smartlabel?id=<SmartLabel ID> #

This endpoint queries Lucidum for details about a single SmartLabel. This endpoint returns:

• a detailed entry for the specified SmartLabel, including all data about the SmartLabel

cURL Example for CMBD/v2/smartlabel?id=<SmartLabel ID> #

In the previous section, we queried the API for information about the SmartLabel named “Encryption Flag Linux 2”. For that SmartLabe, the API returned the SmartLabel ID “68ae117a05b481201589049c”.

If we used that ID, the cURL request would be:

curl --location --request GET 'https://dogfood.lucidum.cloud/CMDB/v2/smartlabel?id=68ae117a05b481201589049c' \
--header 'Content-Type: application/json' \
--header 'Authorization: ••••••' \'

The response looks like this:

{
    "id": "68ae117a05b481201589049c",
    "field_collection": "AWS_CMDB_Output",
    "field_name": "Encryption_Flag_Linux_2_SmartLabel",
    "friendly_name": "Encryption Flag Linux 2",
    "field_description": "Linux asset encryption flag",
    "field_type": "Integer",
    "field_default_value": null,
    "field_default_function": null,
    "field_rules": [
        {
            "rule_name": "Linux assets and Encryption = Yes",
            "field_query_template": "[[{\"friendlyName\":\"Lucidum OS Category\",\"searchFieldName\":\"Lucidum_OS_Type\",\"operator\":\"match\",\"type\":\"String\",\"value\":\"Linux\"}],[{\"friendlyName\":\"Encrypted (True/False)\",\"searchFieldName\":\"Is_Encrypted\",\"operator\":\"==\",\"type\":\"Binary\",\"value\":1}]]",
            "exists_in_result": 1,
            "exists_in_function": null
        },
        {
            "rule_name": "Linux assets",
            "field_query_template": "[[{\"friendlyName\":\"Lucidum OS Category\",\"searchFieldName\":\"Lucidum_OS_Type\",\"operator\":\"match\",\"type\":\"String\",\"value\":\"Linux\"}]]",
            "exists_in_result": 0,
            "exists_in_function": null
        }
    ],
    "field_group": "dynamic",
    "dependsOnSmartLabels": [],
    "metaBlocks": [],
    "status": "COMPLETED",
    "createdBy": "kate",
    "createdAt": "2025-08-26T19:56:42.793Z",
    "lastModifiedBy": "kate",
    "lastModifiedAt": "2025-08-26T19:56:42.793Z",
    "dependsOnTags": [],
    "usedBySmartLabels": [],
    "usedByActions": [],
    "usedByDashboards": [],
    "usedBySavedQueries": [],
    "errorMessage": null,
    "llmDescription": "This smart label identifies Linux assets that have encryption enabled.",
    "llmBusinessValue": "This smart label helps in understanding which Linux-based devices have encryption active, aiding in assessing the security posture and compliance with data protection policies."
}