Skip to main content

Cloud ConnectorsOpen API

Table of Contents

Settings and Reports API

Exabeam Cloud Connectors report various health indicators.

Added: 2.1.16

Prefix all API URLs with:

https://<your-server-ip>:8443/openapi/api/rest/v1/settings/reports

Authentication

The API access is disabled by default.

To enable it, create an integration user and password for use with Basic Authentication (Add Open API Authentication and Roles).

Objects used with these APIs

HealthReportInfo

{
   "fqdn":"string. unique identifier of the reporter. a.k.a type",
   "description":"string",
   "active":"boolean"
}

Get all reporters

GET /types

Response:

200,

List<HealthReportInfo>

Activate a reporter

PUT /types/{fqdn}/activate

> requires integration-admin role

Response:

200,

List<HealthReportInfo>

Deactivate a reporter

PUT /types/{fqdn}/deactivate

> requires integration-admin role

Response:

200,

List<HealthReportInfo>