NSX-T Data Center REST API

Bulk update the status of zero or more Alarms.

Bulk update the status of zero or more Alarms that match the specified filters. The new_status value can be OPEN, ACKNOWLEDGED, SUPPRESSED, or RESOLVED. If new_status is SUPPRESSED, the suppress_duration query parameter must also be specified.

Request:

Method:

POST

URI Path(s):

/api/v1/alarms?action=set_status

Request Headers:

n/a

Query Parameters:

UpdateStatusWithFiltersParameter+

UpdateStatusWithFiltersParameter (schema)

Name	Description	Type	Notes
after	Filter to fetch alarms after the specified time Filter to fetch alarms after the specified time.	EpochMsTimestamp
before	Filter to fetch alarms before the specified time Filter to fetch alarms before the specified time.	EpochMsTimestamp
cursor	Cursor for pagination Opaque cursor to be used for getting next page of records (supplied by current result page).	string
event_type	Event Type Filter Specify one or more event types for which alarms should be filtered.	string
feature_name	Feature Name Specify one or more feature names for which alarms should be filtered.	string
id	Alarm ID Specify one or more alarm IDs for which alarms should be filtered.	string
intent_path	Intent Path for entity ID Specify one or more intent paths for which alarms should be filtered.	string
new_status	Status Specify new alarm status for filtered alarms. Can be one of OPEN, ACKNOWLEDGED, SUPPRESSED, RESOLVED.	MonitoringStatus	Required
node_id	Node ID Specify one or more node IDs for which alarms should be filtered.	string
node_resource_type	Node Resource Type Specify one or more node resource types for which alarms should be filtered.	string
page_size	Page Size for pagination Maximum number of results to return in this page (server may return fewer).	integer
severity	Severity Specify one or more severity levels for which alarms should be filtered. Must be one of CRITICAL, HIGH, MEDIUM, LOW.	string
sort_ascending	Represents order of sorting the values If true, the value of the column are sorted in ascending order. Otherwise, in descending order.	boolean	Default: "True"
sort_by	Key for sorting on this column Sorting on column is based on the sort_by. sort_by represents the field in the output data on which sort is requested.	string
status	Status Specify one or more status for which alarms should be filtered. Must be one of OPEN, ACKNOWLEDGED, SUPPRESSED, RESOLVED.	string
suppress_duration	Duration in hours for which Alarm should be suppressed Specify duration in hours for which Alarm should be suppressed.This value must be specified if the new_status is SUPPRESSED.	integer

Request Body:

n/a

Example Request:

POST /api/v1/alarms/?action=set_status&new_status=ACKNOWLEDGED &status=OPEN

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

n/a

Required Permissions:

crud

Feature:

system_alarms_events

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable