Get a list of active integrations

GET 
/pub/v4.0/xsoar/integrations

To get a list of active integrations (status = success). If third-party license is basic, only three integrations are allowed, otherwise there is no limitation

Request

Query Parameters

customerid stringrequired

The customer ID to which the API call is directed

Responses

200

Successful Response

application/json

Schema

Schema

active_integrations array

The active integration list

max_integrations integer

The maximum allowed active integrations number based on the third-party license type

Example (from schema)

{
  "active_integrations": [
    null
  ],
  "max_integrations": 0
}

ListXsoarIntegrationResponseExample

{
  "active_integrations": [
    "snmp",
    "rapid7"
  ],
  "max_integrations": 5
}

4XX

Client Error Response

application/json

Schema

Schema

code string

STATUS_CODE

msg string

GENERAL_MESSAGE

Example (from schema)

{
  "code": "string",
  "msg": "string"
}

Bad Request

{
  "code": 400,
  "msg": "Bad Request. This occurs when an HTTP request contains an invalid query string."
}

Forbidden access

{
  "code": 403,
  "msg": "Forbidden access. Either the provided API key is invalid or it does not have the required RBAC permissions to run this API."
}

Too many requests

{
  "code": 429,
  "msg": "Too many requests. The number of requests for device details for a single device exceeded the rate limit of 180 queries per minute per tenant."
}

5XX

Server Error Response

application/json

Schema

Schema

code string

STATUS_CODE

msg string

GENERAL_MESSAGE

Example (from schema)

{
  "code": "string",
  "msg": "string"
}

ListXsoarIntegrationResponseExample

{
  "code": 500,
  "msg": "Internal server error. A unified status for API communication type errors."
}

Loading...