Monitoring as a Service (part of Cloud API) (1)

Alarm management endpoints for Monitoring as a Service by IONOS Cloud.

Monitoring as a Service (or just MaaS) is a PaaS service by IONOS Cloud. It is a complimentary “always-on” service that is provided to all compute instances (public cloud servers as well as IONOS Cloud Cubes). “Always-on” means that the user can start using the service directly after provisioning a virtual instance, without the need to select any options or configure additional properties.

What’s more, MaaS is readily available for the already-provisioned VMs, without requiring additional software or any changes to running virtual instances.

The “always-on” monitoring service collects instance metrics and provides options to set up threshold-based alarms and triggers for further actions. Monitoring as a Service currently supports email actions; additional action types will be added in future versions.

The Monitoring API can be used to manage (create/read/update/delete) monitoring alarms and actions.

swagger 3 Source url

Authentication

Basic Authentication

Example:

Authorization: Basic ZGVtbzpwQDU1dzByZA ==

API key

Example:

Authorization: Bearer <token>


Actions

List all Actions

List all Actions for a particular contract.


get https://api.ionos.com/ /cloudapi/monitoring/actions Try out

Create Actions

Create an Action that can be assigned to an arbitrary number of Alarms.



post https://api.ionos.com/ /cloudapi/monitoring/actions Try out

Get Actions by ID

Get an Action by the Action ID.


get https://api.ionos.com/ /cloudapi/monitoring/actions/{actionId} Try out

Update Actions

Update an Action with the specified Action ID.



put https://api.ionos.com/ /cloudapi/monitoring/actions/{actionId} Try out

Delete Actions

Delete an Action with the specified Action ID.


delete https://api.ionos.com/ /cloudapi/monitoring/actions/{actionId} Try out

List all Action executions

List all executions for the specified Action.


get https://api.ionos.com/ /cloudapi/monitoring/actions/{actionId}/executions Try out

Get Action executions by ID

Get an Action execution by Action and execution IDs.


get https://api.ionos.com/ /cloudapi/monitoring/actions/{actionId}/executions/{executionId} Try out

Alarms

List all Alarms

List all Alarms for a particular contract.


get https://api.ionos.com/ /cloudapi/monitoring/alarms Try out

Create Alarms

Create an Alarm. All of the following properties must be provided: "name" and "expression" ("comparisonThreshold", "metric" and "source").



post https://api.ionos.com/ /cloudapi/monitoring/alarms Try out

Get Alarms by ID

Get an Alarm by the Alarm ID.


get https://api.ionos.com/ /cloudapi/monitoring/alarms/{alarmId} Try out

Update Alarms

Update an Alarm. All the following properties must be provided: "name" and "expression" ("comparisonThreshold", "metric" and "source").



put https://api.ionos.com/ /cloudapi/monitoring/alarms/{alarmId} Try out

Delete Alarms

Delete an Alarm with the specified ID.


delete https://api.ionos.com/ /cloudapi/monitoring/alarms/{alarmId} Try out

List Alarm transitions

List all Alarm transitions for a particular contract.


get https://api.ionos.com/ /cloudapi/monitoring/alarms/{alarmId}/transitions Try out

Get Alarm transitions by ID

Get an Alarm transition by Alarm and transition IDs.


get https://api.ionos.com/ /cloudapi/monitoring/alarms/{alarmId}/transitions/{transitionId} Try out

Documentation

Display MaaS OpenAPI spec (JSON)

Display OpenAPI JSON specification for Monitoring as a Service.


get https://api.ionos.com/ /cloudapi/monitoring/openapi.json Try out

Display MaaS OpenAPI spec (YAML)

Display OpenAPI YAML specification for Monitoring as a Service.


get https://api.ionos.com/ /cloudapi/monitoring/openapi.yaml Try out