Useful FortiSOAR Connector API Endpoints

Overview

There are some useful, undocumented API endpoints related to connectors. These API endpoints can be used in playbooks to automate health checks, connector metrics, and activation/deactivation.

API Endpoints

List connectors

Endpoint: /api/integration/connectors/?ordering=label&page_size=50
Method: GET

Configuration Health Check

Endpoint: /api/integration/connectors/healthcheck/<connector name>/<connector version>/?config=<configuration uuid>
Method: GET
Example endpoint: /api/integration/connectors/healthcheck/fortigate-firewall/4.0.0/?config=745d976a-6ae8-4837-a364-64c251ef9e27
Note: The configuration uuid can be found in the "List connectors" output

Activate/Deactivate Connector

Endpoint: /api/integration/connectors/<connector ID>/?format=json
Method: PUT
Body: 
{
  "id": <connector ID>,
  "active": true|false
}
Example Body:
{
  "id": 8,
  "active": false
}
Note: The numeric connector ID can be found in the "List connectors" output

------------------------------
Chris
Staff Software Development Engineer - FortiSOAR
------------------------------