Alerting Config



[tags: DMA]

Resource Root

https://localhost:8443/api/rest/alerting-config

Summary


Resources Methods
https://localhost:8443/api/rest/alerting-config

GET  Retrieves current alerting configuration.

PUT  Updates the alerting configuration.

https://localhost:8443/api/rest/alerting-config/restore-default

POST  Restores the alerting configuration to its default state.

https://localhost:8443/api/rest/alerting-config/defaults

GET  Retrieves alerting configuration default values.

Resources


https://localhost:8443/api/rest/alerting-config


Methods

GET


Retrieves current alerting configuration.
DMA roles required: Administrator

[tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-alerting-config+xml
application/vnd.plcm.plcm-alerting-config+json
Alerting configuration successfully retrieved.
304 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

Alerting configuration has not changed since the last retrieval.

Note: The API client must provide the "plcm-alerting-config" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval.
This will improve network performance by reducing bandwidth consumption.

If the API client chooses to exclude an ETag value from a previous, identical
search in the "If-None-Match" header, then the HTTP response will contain the
search results in the message body.

The "plcm-alerting-config" ETag can be accessed from the initial search result's
HTTP response header. Also, subsequent searches require the identical search
filter to ensure an equivalent ETag value. This also assumes no other client made
changes to the alerting configuration on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Permission denied. DMA roles required: Administrator

PUT


Updates the alerting configuration.
DMA roles required: Administrator

[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-alerting-config+xml
application/vnd.plcm.plcm-alerting-config+json

Response

Status Representation Description
204
Alerting configuration updated successfully. The ETag returned in the HTTP header
represents the version of the current configuration.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Bad request.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Permission denied. DMA roles required: Administrator
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
The supplied alerting configuration is not valid.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Multiple threshold configurations found for a single alert.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
An alert threshold contains an invalid alert code.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Threshold for a specified alert may not be configured.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Threshold for a specified alert contains an unexpected lower bound value.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Threshold for a specified alert contains an invalid lower bound value.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Threshold for a specified alert contains an unexpected upper bound value.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Threshold for a specified alert contains an invalid lower bound value.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Threshold for a specified alert contains conflicting lower and upper bound values.
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

Threshold for a required alert must be configured and enabled.

Required alerts:
- 3103 (server certificate expires soon)
- 3105 (CA certificate expires soon)
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

Threshold for a required alert may not be disabled.

Required alerts:
- 3103 (server certificate expires soon)
- 3105 (CA certificate expires soon)
409 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

Specified thresholds for complementary alerts have conflicting boundary values.

If both alerts 3405 (CPU minor warning) and 3406 (CPU major warning) are
configured and enabled, the upper bound for alert 3405 must be equal to the lower
bound for alert 3406.

https://localhost:8443/api/rest/alerting-config/restore-default


Methods

POST


Restores the alerting configuration to its default state.
DMA roles required: Administrator

[tags: DMA]

Request

Response

Status Representation Description
204
Alerting configuration successfully restored to its default state. The ETag
returned in the HTTP header represents the version of the current
configuration.
400 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Bad request.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Permission denied. DMA roles required: Administrator

https://localhost:8443/api/rest/alerting-config/defaults


Methods

GET


Retrieves alerting configuration default values.
DMA roles required: Administrator

[tags: DMA]

Request

Response

Status Representation Description
200 application/vnd.plcm.plcm-alerting-config+xml
application/vnd.plcm.plcm-alerting-config+json
Default alerting configuration successfully retrieved.
304 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json

Alerting configuration has not changed since the last retrieval.

Note: The API client must provide the "plcm-alerting-config" representation's
ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval.
This will improve network performance by reducing bandwidth consumption.

If the API client chooses to exclude an ETag value from a previous, identical
search in the "If-None-Match" header, then the HTTP response will contain the
search results in the message body.

The "plcm-alerting-config" ETag can be accessed from the initial search result's
HTTP response header. Also, subsequent searches require the identical search
filter to ensure an equivalent ETag value. This also assumes no other client made
changes to the alerting configuration on the server.
403 application/vnd.plcm.plcm-error+xml
application/vnd.plcm.plcm-error+json
Permission denied. DMA roles required: Administrator