REST API

Return links from the root /index of the REST-resource tree

Return links from the root / of the REST-resource tree

Redirects to /alert/definitions

List all Alert Definition

Supports returning a gzip'ed Content-Encoding

Get one AlertDefinition by ID

Create an AlertDefinition for the resource/group/resource type passed as query param. One and only one of the three params must be given at any time. Please also check the POST method for conditions and notifications to see their options

Update the alert definition (priority, enablement, dampening, recovery)

Priority must be HIGH,LOW,MEDIUM. If not provided, LOW is assumed.

Delete an alert definition

This operation is by default idempotent, returning 204.If you want to check if the definition existed at all, you need to pass the 'validate' query parameter.

Remove an alert condition

This operation is by default idempotent, returning 204.If you want to check if the condition existed at all, you need to pass the 'validate' query parameter.

Add a new alert condition to an existing alert definition

Each condition falls into a category. Allowed categories are AVAILABILITY, AVAIL_DURATION, BASELINE(m), CHANGE(m), CONTROL, DRIFT, EVENT, RANGE(m), RESOURCE_CONFIG, THRESHOLD(m), TRAIT(m).Categories with an appended (m) are for metrics and need a metricDefinition, but no name, as the name is obtained from the metric definition. Parameters vary depending on the category:

Update an existing condition of an alert definition.Note that the update will change the ID of the condition

Retrieve a condition of an alert definition by its condition ID

Return a notification definition by its ID

Remove a notification definition

This operation is by default idempotent, returning 204.If you want to check if the notification existed at all, you need to pass the 'validate' query parameter.

Update a notification definition

Add a new notification definition to an alert definition

Return a list of alert notification senders with a short description. The list does not include the configuration definition.

Supports returning a gzip'ed Content-Encoding

Return an alert notification sender by name. This includes information about the configuration it expects

Supports returning a gzip'ed Content-Encoding

List all alerts, possibly limiting by resource or alert definition, priority and start time

Supports returning a gzip'ed Content-Encoding

Return a count of alerts in the system depending on criteria

Get one alert with the passed ID

Return the condition logs for the given alert

Return the notification logs for the given alert

Mark the alert as acknowledged (by the caller)

Returns a slim version of the alert

Remove the alert from the list of alerts

This operation is by default idempotent, returning 204.If you want to check if the alert existed at all, you need to pass the 'validate' query parameter.

Get the alert definition (basics) for the alert

Upload content to the server. This will return a handle that can be used later to retrieve and further process the content

Retrieve the length of the content with the passed handle

Put the uploaded content into the plugin drop box.

This endpoint allows to deploy previously uploaded content as a plugin. You need to providea valid plugin (file) name in order for the plugin processing to succeed. Optionally you canrequest that a plugin scan will be started and the plugin be registered in the system.The content identified by the handle is not removed.

Remove the content with the passed handle

This operation is by default idempotent, returning 204.If you want to check if the content existed at all, you need to pass the 'validate' query parameter.

List the defined event sources for the resource

List the defined event source definitions for the resource

Retrieve the event source with the passed ID

Add a new event source for a resource. This can e.g. be a different logfile. The source.name must match an existing definition fo this resource. If an event source for the definition name and resource with the same location already exists, no new source is created. NOTE: An Event source added this way will not show up in the connection properties.

Delete the event source with the passed ID

This operation is by default idempotent, returning 204.If you want to check if the source existed at all, you need to pass the 'validate' query parameter.

List the events for the event source with the passed ID. If no time range is given, the last 200 entries will be displayed

Supports returning a gzip'ed Content-Encoding

List the events for the resource with the passed ID. If no time range is given, the last 200 entries will be displayed

Supports returning a gzip'ed Content-Encoding

Submit multiple events for one given event source; the event source in the passed Events is ignored.

List all groups

Supports returning a gzip'ed Content-Encoding

Get the group with the passed ID

Create a new group

Update the passed group. Currently only name change is supported

Delete the group with the passed ID

This operation is by default idempotent, returning 204.If you want to check if the group existed at all, you need to pass the 'validate' query parameter.

Get the resources of the group

Supports returning a gzip'ed Content-Encoding

Add a resource to an existing group

If you have created the group as a compatible group and a resource type was provided on creation, only resources with this typemay be added.

Remove the resource with the passed ID from the group

This operation is by default idempotent, returning 204even if the resource was not member of the group.If you want to check if the resource existed at all, you need to pass the 'validate' query parameter.

Get the metric definitions for the compatible group with the passed ID

Supports returning a gzip'ed Content-Encoding

List all existing GroupDefinitions

Supports returning a gzip'ed Content-Encoding

Retrieve a single GroupDefinition by ID

Supports returning a gzip'ed Content-Encoding

Delete the GroupDefinition with the passed ID

This operation is by default idempotent, returning 204.If you want to check if the definition existed at all, you need to pass the 'validate' query parameter.

Create a new GroupDefinition.

The name of the group is required in the passed definition, as well as a non-empty expression. A recalcInterval of 0 means to never recalculate.

Update or recalculate an existing GroupDefinition

If the query param 'recalculate' is set to true, the group with the passed ID is recalculated. Otherwise the existing group will be updated with the passed definition. The expression in the definition must be empty. If the name is emtpy, the old name is kept. A recalcIntervalof 0 means no recalculation.

Get the bucketized metric values for the schedule.

Supports returning a gzip'ed Content-Encoding

Get the bucketized metric values for the metric definition of the group

Supports returning a gzip'ed Content-Encoding

Return bucketized metric data (60 points) for the passed schedules

Supports returning a gzip'ed Content-Encoding

Get the metric schedule for the passed ID

Retrieve a list of high/low/average/data aggregates for the resource

Supports returning a gzip'ed Content-Encoding

Retrieve a list of high/low/average/data aggregates for the group

Supports returning a gzip'ed Content-Encoding

Update the schedule (enabled, interval)

Expose the raw metrics of a single schedule. This can only expose raw data, which means the start date may not be older than 7 days.

Supports returning a gzip'ed Content-Encoding

Submit a single (numerical) metric to the server

Submit a new trait value for the passed schedule ID

Get the current value of the trait with the passed schedule ID

Submit a series of (numerical) metric values to the server

Submit a series of (numerical) metric values for a single resource to the server

Get the current baseline for the schedule

Set a new baseline for the schedule

Retrieve a single operation definition by its ID.

List all operation definitions for a resource

Supports returning a gzip'ed Content-Encoding

Create a new (draft) operation from the passed definition ID for the passed resource

Return a (draft) operation

Update a (draft) operation. If the state is set to 'ready', the operation will be scheduled

Delete a (draft) operation

Return the outcome of the scheduled operation

Supports returning a gzip'ed Content-Encoding

Return the outcome of the executed operations for a resource

Supports returning a gzip'ed Content-Encoding

Delete the operation history item with the passed ID

This operation is by default idempotent, returning 204.If you want to check if the job existed at all, you need to pass the 'validate' query parameter.

List the available reports

Export the AlertDefinitions as CSV

Supports returning a gzip'ed Content-Encoding

Export the Configuration History data as CSV

Supports returning a gzip'ed Content-Encoding

Export the drift compliance data

Supports returning a gzip'ed Content-Encoding

Export the Inventory Summary data as CSV

Supports returning a gzip'ed Content-Encoding

Export the Platform utilization data as CSV

Supports returning a gzip'ed Content-Encoding

Export the Recent Alert data as CSV

Supports returning a gzip'ed Content-Encoding

Export the Recent drift data as CSV

Supports returning a gzip'ed Content-Encoding

Export the Recent Operations Data as CSV

Supports returning a gzip'ed Content-Encoding

Export the Suspect Metrics data as CSV

Supports returning a gzip'ed Content-Encoding

Retrieve a single resource

Update a single resource or import a new resource from the discovery queue.

You can either update a resource that is already in inventory, in which case the fieldsname, description and location can be updated. Or you can import a Platform or Server resource that is in state NEW.To do this you need to PUT the resource retrieved with a COMMITTED state

Search for resources by the given search string, possibly limited by category and paged

Supports returning a gzip'ed Content-Encoding

List all platforms in the system

Supports returning a gzip'ed Content-Encoding

Retrieve the hierarchy of resources starting with the passed one

Supports returning a gzip'ed Content-Encoding

Return the current availability for the passed resource

Return the availability history for the passed resource

Supports returning a gzip'ed Content-Encoding