Bulk Update Alarms

Bulk Update 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
URI
POST
https://nsxmanager.your.domain/api/v1/alarms?action=set_status
COPY
Query Parameters
integer
after
Optional

Timestamp in milliseconds since epoch

integer
before
Optional

Timestamp in milliseconds since epoch

string
cursor
Optional

Cursor for pagination

string
event_tag
Optional

Event tag

string
event_type
Optional

Event Type Filter

string
feature_name
Optional

Feature Name

string
id
Optional

Alarm ID

string
intent_path
Optional

Intent Path for entity ID

string
new_status
Required

Status

Possible values are : OPEN, ACKNOWLEDGED, SUPPRESSED, RESOLVED,
string
node_id
Optional

Node ID

string
node_resource_type
Optional

Node Resource Type

string
org
Optional

Org ID

integer
page_size
Optional

Page Size for pagination

string
project
Optional

Project ID

string
severity
Optional

Severity

boolean
sort_ascending
Optional
Constraints: default: true

Represents order of sorting the values

string
sort_by
Optional

Key for sorting on this column

string
status
Optional

Status

integer
suppress_duration
Optional

Duration in hours for which Alarm should be suppressed

string
vpc
Optional

VPC ID

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Operation doesn't return any data structure

400

Bad Request

Operation doesn't return any data structure

403

Forbidden

Returns Forbidden of type(s) application/json 
{
    "details": "string",
    "error_code": 0,
    "error_data": {},
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_data": {},
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

404
Returns NotFound of type(s) application/json
Operation doesn't return any data structure

412
Returns PreconditionFailed of type(s) application/json
Operation doesn't return any data structure

500
Returns InternalServerError of type(s) application/json
Operation doesn't return any data structure

503
Returns ServiceUnavailable of type(s) application/json
Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' https://{api_host}/api/v1/alarms?action=set_status
On This Page
System Administration Operations
POST
Collect Audit Logs
GET
Get Alarms
GET
Get Alarm
POST
Update Alarm Status
POST
Bulk Update Alarms
GET
Get Automatic Health Check Toggle
PUT
Update Automatic Health Check Toggle
GET
List Automatic Health Checks
GET
Get Automatic Health Check
GET
Get Proton Capacity Thresholds
PUT
Update Proton Capacity Thresholds
GET
Get Proton Capacity Usage
GET
Cluster Cluster Node Id Node List Core Dumps
DELETE
Cluster Cluster Node Id Node Delete Core Dump
POST
Cluster Cluster Node Id Node Copy Core Dump To Remote File Copy To Remote File
POST
Cluster Cluster Node Id Node Set Core Dump Config Set Coredump Config
GET
List Error Resolver Info
GET
Get Error Resolver Info
POST
Resolve Error
GET
List Events
GET
Get Event
PUT
Update Event
POST
Reset Event Values
GET
List Feature Stack Configurations
GET
Get Feature Stack Configuration
PUT
Update Feature Stack Configuration
POST
Reset Aggregation Service Feature Stack Configuration
GET
Get Aggregation Service Global Config
PUT
Update Aggregation Service Global Config
GET
List Latency Profiles
Deprecated
POST
Create Latency Stat Profile
Deprecated
DELETE
Delete Latency Stat Profile
Deprecated
GET
Read Latency Stat Profile
Deprecated
PUT
Update Latency Profile
Deprecated
GET
Node List Core Dumps
DELETE
Node Delete Core Dump
POST
Node Copy Core Dump To Remote File Copy To Remote File
POST
Node Set Core Dump Config Set Coredump Config
GET
List Notification Watchers
POST
Add Notification Watcher
DELETE
Delete Notification Watcher
GET
Get Notification Watcher
PUT
Update Notification Watcher
GET
Get Notifications
PUT
Update Notifications
POST
Add Uri Filters
POST
Delete Uri Filters
GET
Show All Appliance Latency Data
GET
Show ALL Appliance Process Data
GET
Show Appliance Latency Data
GET
Show Appliance Process Data
GET
Read Container Cluster Status List
POST
Create Container Cluster Status
DELETE
Delete Container Cluster Summary
GET
Read Container Cluster Status
GET
List All System Health Plugins
Deprecated
POST
Create System Health Plugin
Deprecated
GET
Show System Health Plugin On Node
DELETE
Delete System Health Plugin
Deprecated
GET
Show System Health Plugin
Deprecated
POST
Create Plugin File
GET
List System Health Agent Profiles
Deprecated
POST
Create System Health Agent Profile
Deprecated
DELETE
Delete System Health Agent Profile
Deprecated
GET
Show System Health Agent Profile
Deprecated
PUT
Update System Health Agent Profile
Deprecated
GET
Read Tn Container Agent Status
GET
Read Tn Hyperbus Status
GET
Transport Nodes Transport Node Id Node List Core Dumps
DELETE
Transport Nodes Transport Node Id Node Delete Core Dump
POST
Transport Nodes Transport Node Id Node Copy Core Dump To Remote File Copy To Remote File
POST
Transport Nodes Transport Node Id Node Set Core Dump Config Set Coredump Config
GET
List Views
Deprecated
POST
Create View
Deprecated
DELETE
Delet View
Deprecated
GET
Get View
Deprecated
PUT
Update View
Deprecated
GET
List Widget Configurations
Deprecated
POST
Create Widget Configuration
Deprecated
DELETE
Delete Widget Configuration
Deprecated
GET
Get Widget Configuration
Deprecated
PUT
Update Widget Configuration
Deprecated