Lucidum’s cyber beard is thriving! A Rising in Cyber 2025 Honoree! See the wisdom behind the whiskers → [Learn More!]

Lucidum’s cyber beard is thriving! A Rising in Cyber 2025 Honoree! See the wisdom behind the whiskers → [Learn More!]
View Categories

Endpoints for Connectors and Connector Profiles

Estimated Reading Time: 21 min read

You can use the Lucidum API to:

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:

Retrieve the List of Connectors: /CMDB/v2/connector #

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

  • an entry for each connector

  • the bridge name (connector name), display name, description, group, and status of each connector

Endpoint

Method

Parameters in URL

/CMDB/v2/connector

GET

  • None

Example cURL Request #

curl --location 'https://test.dev.luciduminc.net/CMDB/v2/connector/' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **********'

  • Line 1. The cURL call. The method defaults to GET. The URL is host name plus the endpoint for the connector API.

  • Line 2. The header specifies to return results in JSON.

  • Line 3. The header specifies to use a Bearer Token for authentication and provides the bearer token.

Example Response #

The response includes thousands of lines. Here is an abbreviated response that shows the first three connector records:

{
    “connectors”: [
        {
            “connector_name”: “api”,
            “bridge_name”: “ad_ldap”,
            “display_name”: “Microsoft Active Directory (AD)”,
            “description”: “Microsoft Active Directory (AD) provides a single point of control for managing users, computers, groups, and other resources on a network. Active Directory uses a structured data store as the basis for a logical, hierarchical organization of directory information.”,
            “group”: “Identity Access Management”,
            “status”: “available”
        },
        {
            “connector_name”: “api”,
            “bridge_name”: “addigy”,
            “display_name”: “Addigy”,
            “description”: “Addigy is a cloud-based, multi-tenant mobile device management solution that manages macOS, iOS, iPadOS, and iOS devices.”,
            “group”: “Asset Management”,
            “status”: “available”
        },
        {
            “connector_name”: “api”,
            “bridge_name”: “artifactory”,
            “display_name”: “Artifactory”,
            “description”: “JFrog Artifactory is a universal DevOps solution providing end-to-end automation and management of binaries and artifacts through the application delivery process that improves productivity across your development ecosystem.”,
            “group”: “Code Management”,
            “status”: “available”
        },

Retrieve Configuration Details About a Single Connector: /CMDB/v2/connector/config #

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

  • an entry for each connector

  • the bridge name (connector name), display name, description, group, and status of each connector

  • the configured fields for the connector

    NOTE: Credentials are not returned in the API.

Endpoint

Method

Parameters in URL

/CMDB/v2/connector/config

GET
  • connector_name=api
  • bridge_name=<bridge name of connector>
NOTE: To find the bridge_name of a connector, you can use the /CMDB/v2/connector endpoint and search the results for the connector you are interested in.

Example cURL Request #

curl --location 'https://test.dev.luciduminc.net/CMDB/v2/connector/config?connector_name=api&bridge_name=datadog' \
--header 'Content-Type: application/json' \
-header 'Authorization: Bearer **********'

  • Line 1. The cURL call. If no method is specified, the method defaults to GET. The URL is host name plus the endpoint for the connector API.

  • Line 1. The “?” (question mark) character specifies that all the text to the right of the character is a parameter.

  • Line 1. connector_name=api is required. This parameter is identical for all connectors.

  • Line 1. The “&” (ampersand) character specifies that the test to the right of the character is an additional parameter.

  • Line 1. bridge_name=datadog. This parameter specifies the connector to retrieve configuration information for.

    NOTE: To find the bridge_name of a connector, you can use the /CMDB/v2/connector endpoint and search the results for the connector you are interested in.

  • Line 2. The header specifies to return results in JSON.

  • Line 3. The header specifies to use a Bearer Token for authentication and provides the bearer token.

Example Response #

The response looks like this:

NOTE: Credentials are not returned in the API.

{
    “connector_name”: “api”,
    “bridge_name”: “datadog”,
    “display_name”: “Datadog Enterprise”,
    “description”: “Datadog allows observability for cloud-scale applications, providing monitoring of servers, databases, tools, and services, through a SaaS-based data analytics platform.”,
    “group”: “Monitoring”,
    “status”: “available”,
    “config”: {
        “url”: “https://api.datadoghq.com”,
        “app_key”: “”,
        “api_key”: “”,
        “verify_ssl”: false,
        “field_metadata”: {
            “app_key”: “encrypt;required”,
            “api_key”: “encrypt;required”
        },
        “field_display”: {
            “url”: {
                “display_name”: “URL”,
                “description”: “The URL of the Datadog API, default value is https://api.datadoghq.com”
            },
            “app_key”: {
                “display_name”: “App Key”,
                “description”: “Datadog application key”
            },
            “api_key”: {
                “display_name”: “API Key”,
                “description”: “Datadog API key”
            },
            “verify_ssl”: {
                “display_name”: “Verify SSL”,
                “description”: “Toggle on/off validation of SSL certificate”
            }
        }
    }
}

Create a Profile for a Connector: /CMDB/v2/connector/profile #

This endpoint creates a new profile for a connector. You must test the profile after creation. This endpoint creates but does not test the new profile.

NOTE: Certain connectors, like the Google Cloud Platform connector or the ADP connector, require you to upload a file when creating a profile. You cannot create profiles for these connectors with API v2.

Method

Parameters in URL

/CMDB/v2/connector/profile

POST
  • connector_name: api
  • bridge_name: <bridge name of connector>
  • profile_name: <name for new profile>
  • url: <url for the connector third-party API>
  • fields required by config.field_metadata

To determine the field required by config.field_metadata:

Retrieve data from the endpoint /CMDB/v2/connector/config?connector_name=api&bridge_name=<bridge name for connector>.

NOTE: To find the bridge_name of a connector, you can use the /CMDB/v2/connector endpoint and search the results for the connector you are interested in.

Finding config.field_metadata #

To find the config.field_metadata fields to create a profile, you need to look at the configuration information for the connector.

For example, for the Datadog connector, call the endpoint /CMDB/v2/connector/config?connector_name=api&bridge_name=datadog

The results look like this:

{
    “connector_name”: “api”,
    “bridge_name”: “datadog”,
    “display_name”: “Datadog Enterprise”,
    “description”: “Datadog allows observability for cloud-scale applications, providing monitoring of servers, databases, tools, and services, through a SaaS-based data analytics platform.”,
    “group”: “Monitoring”,
    “status”: “available”,
    “config”: {
        “url”: “https://api.datadoghq.com”,
        “app_key”: “”,
        “api_key”: “”,
        “verify_ssl”: false,
        “field_metadata”: {
            “app_key”: “encrypt;required”,
            “api_key”: “encrypt;required”
      },
        “field_display”: {
            “url”: {
                “display_name”: “URL”,
                “description”: “The URL of the Datadog API, default value is https://api.datadoghq.com”
            },
            “app_key”: {
                “display_name”: “App Key”,
                “description”: “Datadog application key”
            },
            “api_key”: {
                “display_name”: “API Key”,
                “description”: “Datadog API key”
            },
            “verify_ssl”: {
                “display_name”: “Verify SSL”,
                “description”: “Toggle on/off validation of SSL certificate”
            }
        }
    }
}

  • Under the config section, find the section called field_metadata.

  • Note that the app_key and api_key fields are noted as required.

  • This means that you must include these two fields when creating a profile for the Datadog connector.

Example cURL Request #

curl --request POST --location 'https://test.dev.luciduminc.net/CMDB/v2/connector/profile' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **********' \
--data '{
"connector_name": "api",
"bridge_name": "datadog",
"profile_name": "customer_support",
"url": "https://api.datadoghq.com",
"app_key": "123456789011",
"api_key": "109876543210",
}'

  • Line 1. The cURL call. We specified “–request POST” so we can send data to Lucidum. The URL is host name plus the endpoint for the connector API.

  • Line 1. The The “\” (backslash) at the end of a line indicates to continue the cURL command on the next line and process all the lines as a single request.

  • Line 2. The header specifies to return results in JSON.

  • Line 3. The header specifies to use a Bearer Token for authentication and provides the bearer token.

  • Line 4. The data to send to Lucidum.

  • Line 5. “connector_name”: “api”  is required. This parameter is identical for all connectors.

  • Line 6. “bridge_name”: “datadog” This parameter specifies the connector to create a profile for.

    NOTE: To find the bridge_name of a connector, you can use the /CMDB/v2/connector endpoint and search the results for the connector you are interested in.

  • Line 7.  “profile_name”: “customer_support”. The name of the new profile.

  • Line 8. “url”: “https://api.datadoghq.com”. The optional URL for the Datadog API.

  • Line 9. “app_key”: “123456789011“. The required app_key for the Datadog profile.

  • Line 10. “api_key”: “109876543210“. The required api_key for the Datadog profile.

Example Response #

The response looks like this:

{
    “url”: “https://api.datadoghq.com”,
    “app_key”: “**************************”,
    “api_key”: “**************************”,
    “field_metadata”: {
        “app_key”: “encrypt;required”,
        “api_key”: “encrypt;required”
    },
    “field_display”: {
        “url”: {
            “display_name”: “URL”,
            “description”: “The URL of the Datadog API, default value is https://api.datadoghq.com”
        },
        “app_key”: {
            “display_name”: “App Key”,
            “description”: “Datadog application key”
        },
        “api_key”: {
            “display_name”: “API Key”,
            “description”: “Datadog API key”
        },
        “verify_ssl”: {
            “display_name”: “Verify SSL”,
            “description”: “Toggle on/off validation of SSL certificate”
        }
    },
    “active”: true,
    “description”: “Datadog allows observability for cloud-scale applications, providing monitoring of servers, databases, tools, and services, through a SaaS-based data analytics platform.”,
    “display_name”: “Datadog Enterprise”,
    “status”: “available”,
    “group”: “Monitoring”,
    “connector_name”: “api”,
    “bridge_name”: “datadog”,
    “profile_name”: “customer_support”,
    “modified_time”: “2024-09-24T14:59:42.476652Z”,
    “services_list”: [
        {
            “platform”: “api”,
            “type”: “user_info”,
            “display_name”: “Datadog User”,
            “service”: “datadog_user”,
            “activity”: true,
            “status”: “FAIL”,
            “message”: “not tested”
        },
        {
            “platform”: “api”,
            “type”: “asset_info”,
            “display_name”: “Datadog Host”,
            “service”: “datadog_host”,
            “activity”: true,
            “status”: “FAIL”,
            “message”: “not tested”
        },
        {
            “platform”: “api”,
            “type”: “asset_info”,
            “display_name”: “Datadog Container”,
            “service”: “datadog_container”,
            “activity”: true,
            “status”: “FAIL”,
            “message”: “not tested”
        }
    ],
    “profile_id”: “66f2d3de9cb7671a2c4b0c75”
}

Retrieve the List of Profiles for All Connectors: /CMDB/v2/connector/profile #

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

  • an entry for each connector

  • the bridge name (connector name), display name, description, group, and status of each connector

Endpoint

Method

Parameters in URL

/CMDB/v2/connector/profile

GET

  • None

Example cURL Request #

curl --location 'https://test.dev.luciduminc.net/CMDB/v2/connector/profile' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **********'

  • Line 1. The cURL call. If no method is specified, the method defaults to GET. The URL is host name plus the endpoint for the connector API.

  • Line 2. The header specifies to return results in JSON.

  • Line 3. The header specifies to use a Bearer Token for authentication and provides the bearer token.

Example Response #

The response includes thousands of lines. Here is an abbreviated response that shows a single connector profile:

{
    “connectorProfiles”: [
        {
            “app_id”: “***************************”,
            “app_secret”: “***************************”,
            “tenant_id”: “***************************”,
            “url”: “https://fef.amsua0602.manage.microsoft.com/ReportingService/DataWarehouseFEService/”,
            “field_metadata”: {
                “app_id”: “required”,
                “app_secret”: “encrypt;required”,
                “tenant_id”: “required”,
                “url”: “required”
            },
            “field_display”: {
                “url”: {
                    “display_name”: “URL”,
                    “description”: “Microsoft intune URL. For example, https://<intune subdomain>.manage.microsoft.com/ReportingService/DataWarehouseFEService/”
                },
                “app_id”: {
                    “display_name”: “Client ID”,
                    “description”: “Client ID for the application”
                },
                “app_secret”: {
                    “display_name”: “Client secret”,
                    “description”: “Client secret for the application”
                },
                “tenant_id”: {
                    “display_name”: “Tenant ID”,
                    “description”: “Microsoft Azure tenant ID”
                }
            },
            “status”: “available”,
            “bridge_name”: “intune”,
            “connector_name”: “api”,
            “display_name”: “Microsoft Intune”,
            “description”: “Microsoft Intune is a cloud-based service that focuses on mobile device management (MDM) and mobile application management (MAM).”,
            “active”: true,
            “profile_name”: “Default profile”,
            “services_list”: [
                {
                    “connection”: “intune”,
                    “connector”: “api”,
                    “service”: “intune_device”,
                    “status”: “OK”,
                    “activity”: true
                },
                {
                    “connection”: “intune”,
                    “connector”: “api”,
                    “service”: “intune_user”,
                    “status”: “OK”,
                    “activity”: true
                }
            ],
            “profile_id”: “62268b697ad01232db4bc3a7”
        },

Retrieve a Single Profile for a Single Connector: /CMDB/v2/connector/profile #

This endpoint queries Lucidum for details about a single profile for a single connector.

Endpoint

Method

Parameters in URL

/CMDB/v2/connector/profile

GET
  • connector_name=api
  • bridge_name=<bridge name of connector>
  • profile_name=<profile name>

NOTE: To find the bridge_name of a connector, you can use the /CMDB/v2/connector endpoint and search the results for the connector you are interested in.</0>

NOTE: To find the profile_name for a connector, you can use the /CMDB/v2/connector/profile endpoint and search the results for the profile you are interested in.

Example cURL Request #

curl --location 'https://test.dev.luciduminc.net/CMDB/v2/connector/profile?connector_name=api&bridge_name=datadog&profile_name=api profile 1' \
--header 'Content-Type: application/json' \
-header 'Authorization: Bearer **********'

  • Line 1. The cURL call. If no method is specified, the method defaults to GET. The URL is host name plus the endpoint for the connector API.

  • Line 1. The “?” (question mark) character specifies that all the text to the right of the character is a parameter.

  • Line 1. connector_name=api is required. This parameter is identical for all connectors.

  • Line 1. The “&” (ampersand) character specifies that the test to the right of the character is an additional parameter.

  • Line 1. bridge_name=datadog. This parameter specifies the connector to retrieve information from.

    NOTE: To find the bridge_name of a connector, you can use the /CMDB/v2/connector endpoint and search the results for the connector you are interested in.

  • Line 1. profile_name=api profile 1. This parameter specifies the profile to retrieve information from.

    NOTE: To find the profile_name for a connector, you can use the /CMDB/v2/connector/profile endpoint and search the results for the profile you are interested in.

  • Line 2. The header specifies to return results in JSON.

  • Line 3. The header specifies to use a Bearer Token for authentication and provides the bearer token.

Example Response #

{
    “connectorProfiles”: [
        {
            “url”: “https://api.datadoghq.com”,
            “app_key”: “abcdefghiklmnopqrstuvwxya”,
            “api_key”: 12345678910111213″,
            “verify_ssl”: false,
            “field_metadata”: {
                “app_key”: “encrypt;required”,
                “api_key”: “encrypt;required”
            },
            “field_display”: {
                “url”: {
                    “display_name”: “URL”,
                    “description”: “The URL of the Datadog API, default value is https://api.datadoghq.com”
                },
                “app_key”: {
                    “display_name”: “App Key”,
                    “description”: “Datadog application key”
                },
                “api_key”: {
                    “display_name”: “API Key”,
                    “description”: “Datadog API key”
                },
                “verify_ssl”: {
                    “display_name”: “Verify SSL”,
                    “description”: “Toggle on/off validation of SSL certificate”
                }
            },
            “active”: true,
            “description”: “Datadog allows observability for cloud-scale applications, providing monitoring of servers, databases, tools, and services, through a SaaS-based data analytics platform.”,
            “display_name”: “Datadog Enterprise”,
            “status”: “available”,
            “group”: “Monitoring”,
            “connector_name”: “api”,
            “bridge_name”: “datadog”,
            “profile_name”: “api profile 1”,
            “modified_time”: “2024-09-03T15:42:32.778+00:00”,
            “services_list”: [
                {
                    “platform”: “api”,
                    “type”: “user_info”,
                    “display_name”: “Datadog User”,
                    “service”: “datadog_user”,
                    “activity”: true,
                    “status”: “OK”,
                    “message”: “success”
                },
                {
                    “platform”: “api”,
                    “type”: “asset_info”,
                    “display_name”: “Datadog Host”,
                    “service”: “datadog_host”,
                    “activity”: true,
                    “status”: “OK”,
                    “message”: “success”
                },
                {
                    “platform”: “api”,
                    “type”: “asset_info”,
                    “display_name”: “Datadog Container”,
                    “service”: “datadog_container”,
                    “activity”: true,
                    “status”: “OK”,
                    “message”: “success”
                }
            ],
            “profile_id”: “66d72e68ccb4dc5bc98c286e”
        }
    ]
}

Delete a Single Profile for a Single Connector: /CMDB/v2/connector/profile #

This endpoint deletes a single profile for a single connector.

Endpoint

Method

Parameters in URL

/CMDB/v2/connector/profile

DELETE
  • connector_name=api
  • bridge_name=<bridge name of connector>
  • profile_name=<profile name>

NOTE: To find the bridge_name of a connector, you can use the /CMDB/v2/connector endpoint and search the results for the connector you are interested in.

NOTE: To find the profile_name for a connector, you can use the /CMDB/v2/connector/profile endpoint and search the results for the profile you are interested in.

Example cURL Request #

curl --request DELETE --location 'https://test.dev.luciduminc.net/CMDB/v2/connector/profile?connector_name=api&bridge_name=datadog&profile_name=api profile 1' \
--header 'Content-Type: application/json' \
-header 'Authorization: Bearer **********'

  • Line 1. The cURL call. We specified “–request DELETE ” so we can delete a profile. The URL is host name plus the endpoint for the connector API.

  • Line 1. The “?” (question mark) character specifies that all the text to the right of the character is a parameter.

  • Line 1. connector_name=api is required. This parameter is identical for all connectors.

  • Line 1. The “&” (ampersand) character specifies that the test to the right of the character is an additional parameter.

  • Line 1. bridge_name=datadog. This parameter specifies the connector to delete information from.

    NOTE: To find the bridge_name of a connector, you can use the /CMDB/v2/connector endpoint and search the results for the connector you are interested in.

  • Line 1. profile_name=api profile 1. This parameter specifies the profile to delete.

    NOTE: To find the profile_name for a connector, you can use the /CMDB/v2/connector/profile endpoint and search the results for the profile you are interested in.

  • Line 2. The header specifies to return results in JSON.

  • Line 3. The header specifies to use a Bearer Token for authentication and provides the bearer token.

Example Response #

{
    “removed”: true
}

Test a Connector: /CMDB/v2/connector/test/async #

This endpoint tests a single connector using a single profile.

Method

Parameters in URL

/CMDB/v2/connector/test/async

POST
  • connector_name: api
  • bridge_name: <bridge name of connector>
  • profile_name: <name for new profile>

NOTE: To find the bridge_name of a connector, you can use the /CMDB/v2/connector endpoint and search the results for the connector you are interested in.

NOTE: To find the profile_name for a connector, you can use the /CMDB/v2/connector/profile endpoint and search the results for the profile you are interested in.

Example cURL Request #

curl --request POST --location 'https://test.dev.luciduminc.net/CMDB/v2/connector/test/async' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **********' \
--data '{
"connector_name": "api",
"bridge_name": "datadog",
"profile_name": "customer_support",
}'

  • Line 1. The cURL call. We specified “–request POST” so we can send data to Lucidum. The URL is host name plus the endpoint for the connector API.

  • Line 1. The The “\” (backslash) at the end of a line indicates to continue the cURL command on the next line and process all the lines as a single request.

  • Line 2. The header specifies to return results in JSON.

  • Line 3. The header specifies to use a Bearer Token for authentication and provides the bearer token.

  • Line 4. The data to send to Lucidum.

  • Line 5. “connector_name”: “api”  is required. This parameter is identical for all connectors.

  • Line 6. “bridge_name”: “datadog” This parameter specifies the connector to create a profile for.

    NOTE: To find the bridge_name of a connector, you can use the /CMDB/v2/connector endpoint and search the results for the connector you are interested in.

  • Line 7. profile_name: “api profile 1”. This parameter specifies the profile to delete.

    NOTE: To find the profile_name for a connector, you can use the /CMDB/v2/connector/profile endpoint and search the results for the connector you are interested in.

Example Response #

{
    “traceId”: “66f418ec69a1e873b8ef4f57”
}

Viewing Test Results: /CMDB/v2/connector/test/result #

This endpoint tests a single connector using a single profile.

Method

Parameters in URL

/CMDB/v2/connector/test/result

GET
  • traceId: <traceId returned by /CMDB/v2/connector/test/async endpoint>

NOTE: To find the traceID for test results, you can use the /CMDB/v2/connector/test/async endpoint. This endpoint returns the traceID.

Example cURL Request #

curl --location 'https://test.dev.luciduminc.net/CMDB/v2/connector/test/result?traceId=66f418ec69a1e873b8ef4f57' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **********' \

  • Line 1. The cURL call. If no method is specified, the method defaults to GET. The URL is host name plus the endpoint for the connector API.

  • Line 1. The “?” (question mark) character specifies that all the text to the right of the character is a parameter.

  • Line 1. traceId=66f418ec69a1e873b8ef4f57. This parameter specifies the test results to display.

    NOTE: To find the traceID for test results, you can use the /CMDB/v2/connector/test/async endpoint. This endpoint returns the traceID.

  • The The “\” (backslash) at the end of a line indicates to continue the cURL command on the next line and process all the lines as a single request.

  • Line 2. The header specifies to return results in JSON.

  • Line 3. The header specifies to use a Bearer Token for authentication and provides the bearer token.

Example Response #

{
    “connector_name”: “api”,
    “bridge_name”: “datadog”,
    “trace_id”: “66f41e0b69a1e873b8ef4f62”,
    “profile_db_id”: “66d72e68ccb4dc5bc98c286e”,
    “test_result”: [
        {
            “name”: “datadog_user”,
            “status”: “FAIL”,
            “message”: “403 Client Error: Forbidden for url: https://api.datadoghq.com/api/v2/users?page%5Bnumber%5D=0&page%5Bsize%5D=2”,
            “details”: [
                {
                    “name”: “connection”,
                    “status”: “OK”,
                    “message”: “success”
                },
                {
                    “name”: “http_error”,
                    “status”: “FAIL”,
                    “message”: “403 Client Error: Forbidden for url: https://api.datadoghq.com/api/v2/users?page%5Bnumber%5D=0&page%5Bsize%5D=2”
                }
            ],
            “display_name”: “Datadog User”
        },
        {
            “name”: “datadog_host”,
            “status”: “FAIL”,
            “message”: “403 Client Error: Forbidden for url: https://api.datadoghq.com/api/v2/hosts?start=0&count=5”,
            “details”: [
                {
                    “name”: “connection”,
                    “status”: “OK”,
                    “message”: “success”
                },
                {
                    “name”: “http_error”,
                    “status”: “FAIL”,
                    “message”: “403 Client Error: Forbidden for url: https://api.datadoghq.com/api/v2/hosts?start=0&count=5”
                }
            ],
            “display_name”: “Datadog Host”
        },
        {
            “name”: “datadog_container”,
            “status”: “FAIL”,
            “message”: “403 Client Error: Forbidden for url: https://api.datadoghq.com/api/v2/containers?page%5Bsize%5D=5”,
            “details”: [
                {
                    “name”: “connection”,
                    “status”: “OK”,
                    “message”: “success”
                },
                {
                    “name”: “http_error”,
                    “status”: “FAIL”,
                    “message”: “403 Client Error: Forbidden for url: https://api.datadoghq.com/api/v2/containers?page%5Bsize%5D=5”
                }
            ],
            “display_name”: “Datadog Container”
        }
    ],
    “last_tested_at”: “2024-09-25T14:28:55.307+00:00”,
    “status”: “done”
}

Enable or Disable a Connector Service: /CMDB/v2/connector/profile/service #

This endpoint disables or enables a service for a specified profile and connector combination.

Method

Parameters in URL

/CMDB/v2/connector/profile/service

PUT
  • connector_name: api
  • bridge_name: <bridge name of connector>
  • profile_name: <profile name you want to enable or disable>
  • services_list: <service_list>. You must include the name of the service and the value for “activity”.
    • To enable a service: “activity”: true
    • To disable a service: “activity”: false

NOTE: To find the bridge_name of a connector, you can use the /CMDB/v2/connector endpoint and search the results for the connector you are interested in.

NOTE: To find the profile_name for a connector, you can use the /CMDB/v2/connector/profile endpoint and search the results for the profile you are interested in.

NOTE: To find the services_list for a connector, you can use the /CMDB/v2/connector/profile endpoint and search the results for the profile you are interested in. Not all connectors have multiple services.

Example cURL Request #

curl --location --request PUT 'https://dogfood.lucidum.cloud/CMDB/v2/connector/profile/service' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer **********' \
--data '{
"profile_name": "Test",
"bridge_name": "crowdstrike",
"connector_name": "api",
"services_list": [
{
"service": "crowdstrike_host",

"activity": false
}
]
}'

  • Line 1. The cURL call. We specified “–request PUT” so we can update data to Lucidum. The URL is host name plus the endpoint for the connector API.

  • Line 1. The The “\” (backslash) at the end of a line indicates to continue the cURL command on the next line and process all the lines as a single request.

  • Line 2. The header specifies to return results in JSON.

  • Line 3. The header specifies to use a Bearer Token for authentication and provides the bearer token.

  • Line 4. The data to send to Lucidum.

  • Line 5. “profile_name”: “Test “. The name of the profile for this instance of the connector.

  • Line 6. “bridge_name”: “crowdstrike” This parameter specifies the connector for which we want to start or stop a service.

  • Line 7. “connector_name”: “api”  is required. This parameter is identical for all connectors.

  • Line 8. “services_list”: specifies one or more services to start of stop.

  • Line 9. “service”: “crowdstrike_host” specifies the service to start or stop.

  • Line 10 “activity”: false specifies to stop the service. Setting “activity” to true starts the service.

Example Response #

In the JSON response, we can see that the Connector Profile was updated so that the service CrowdStrike Host was disabled. This is the same action as toggling off the services in the Lucidum UI.

{
    “host”: “https://api.us-2.crowdstrike.com”,
    “client_id”: “***********************”,
    “api_secret”: “*************************”,
    “threading”: false,
    “verify_ssl”: false,
    “field_metadata”: {
        “host”: “required”,
        “client_id”: “required”,
        “api_secret”: “encrypt;required”
    },
    “field_display”: {
        “host”: {
            “display_name”: “URL”,
            “description”: “The URL of the CrowdStrike API. For example, https://api.crowdstrike.com”
        },
        “verify_ssl”: {
            “display_name”: “Verify SSL”,
            “description”: “Toggle on/off validation of SSL certificate”
        },
        “client_id”: {
            “display_name”: “Client ID”,
            “description”: “CrowdStrike client ID”
        },
        “api_secret”: {
            “display_name”: “API Secret”,
            “description”: “CrowdStrike API secret”
        },
        “threading”: {
            “display_name”: “Parallel Data Collection”,
            “description”: “Toggle on/off parallel data collection, default is single threading”
        }
    },
    “active”: true,
    “bridge_name”: “crowdstrike”,
    “connector_name”: “api”,
    “description”: “CrowdStrike Falcon Endpoint Protection is a cloud-based platform that protects laptops, desktops, and servers from breaches.”,
    “display_name”: “CrowdStrike Falcon Endpoint Protection”,
    “group”: “Endpoint Detection and Protection”,
    “profile_name”: “Test”,
    “services_list”: [
        {
            “platform”: “api”,
            “type”: “”,
            “display_name”: “CrowdStrike Host”,
            “service”: “crowdstrike_host”,
            “status”: “OK”,
            “message”: “success”,
            “activity”: false
        }
    ],
    “status”: “available”,
    “modified_time”: “2025-09-02T21:32:01.629276605Z”,
    “last_tested_at”: “2025-09-02T01:29:26.927+00:00”,
    “profile_id”: “66798a96fd2e8f6ec7d1f91f”
}
What are your Feelings

Solutions

COMPANY

Resource Library