About

Integrations endpoint returns SIEM/EDR integration list. If any integration configuration is completed, you can reach out integration id, name, health status and connected integration agent information as in Picus platform > Integrations.

Return Definitions

health status = health means that the integration is healthy and detection analytics on the agent can continue to work
health status = unhealthy means that the detection analytics cannot be executed until the integration configuration is fixed.
If the health status is unhealthy, detailed information about the error will be returned.

Example

curl --request GET \
     --url https://api.picussecurity.com/v1/integrations \
     --header 'Accept: application/json' \
     --header 'Authorization: Bearer access_token'

{
  "integrations": [
    {
      "id": 1,
      "name": "Splunk",
      "type": "SIEM",
      "description": "Splunk is the world’s first Data-to-Everything Platform.",
      "created_at": 1646136456713,
      "updated_at": 1652191182767,
      "health_status": {
        "healthy": true
      },
      "integration_agent_id": 1,
      "integration_agent": "Picus Agent 2"
    },
    {
      "id": 8,
      "name": "VMware Carbon Black EDR",
      "type": "EDR",
      "description": "Consolidates multiple endpoint security capabilities, helping users operate faster and more effectively.",
      "created_at": 1649422318325,
      "updated_at": 1653995321307,
      "health_status": {
        "healthy": false,
        "error": {
          "step": "Connection",
          "type": "VMware Carbon Black EDR Authentication Check Step Error",
          "message": "http request error - Connection Error: Post \"https://1.1.1.1:1156/_search\": dial tcp 1.1.1.1:1156: connect: no route to host - Status Code: 0"
        }
      },
      "integration_agent_id": 1,
      "integration_agent": "Picus Agent"
    }
  ]
}

200IntegrationsReturnSwagger

defaultgenericErrorSwagger is represents the erroneous cases