Settings/Reports API

Added: 2.1.16

All API URLs should be prefixed with
https://<your-server-ip>:8443/openapi/api/rest/v1/settings/reports

• Settings/Reports API
  • Preface
  • Authentication
  • Objects used with these APIs
    • HealthReportInfo
  • Get all reporters
  • Activate a reporter
  • Deactivate a reporter

Preface

The following post detail how to interact with the SkyFormation settings using APIs.

SkyFormation reports various health indicators, please refer this document for further details.

Authentication

The API access is disabled by default.
To enable it create an integration user & password for use with Basic Authentication (guide).

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>