@itentialopensource/adapter-ciena_mcp

{ "openapi": "3.0.0", "info": { "title": "Ciena MCP 5.3", "description": "Ciena MCP API specification", "contact": {}, "version": "5.3.0" }, "servers": [ { "url": "http://localhost/", "variables": {} }, { "url": "https://localhost/", "variables": {} } ], "paths": { "/nsa/api/v1/alarms/alarmRecordsCounts": { "get": { "tags": [ "Retrieve and modify alarms (version 1)" ], "summary": "getTotalRecordsCount", "description": "Alarm record counts returned in JSON format.", "operationId": "getTotalRecordsCount", "parameters": [], "responses": { "200": { "description": "Successfully retrieved the total number of alarm records", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TotalAlarmRecordsCount" } } } }, "500": { "description": "Request failed (error message provided)", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "deprecated": false } }, "/nsa/api/v1/alarms/device-types": { "get": { "tags": [ "Retrieve and modify alarms (version 1)" ], "summary": "getDeviceTypes", "description": "Device types returned in JSON format.", "operationId": "getDeviceTypes", "parameters": [], "responses": { "200": { "description": "Successfully retrieved device types", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceTypesRO" } } } }, "400": { "description": "Bad Request", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "404": { "description": "No device types found", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "500": { "description": "Returning collection of device types failed", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "deprecated": false } }, "/nsa/api/v1/alarms/deviceAttributes/{Id}": { "get": { "tags": [ "Retrieve and modify alarms (version 1)" ], "summary": "getDeviceAttributes", "description": "Device specific attributes returned in JSON format.", "operationId": "getDeviceAttributes", "parameters": [ { "name": "Id", "in": "path", "description": "Requested node Identifier.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successfully retrieved device attributes by device session id", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceAttributesRO" } } } }, "400": { "description": "Bad Request", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "404": { "description": "Device attributes not found", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "500": { "description": "Device attributes request failed (error message provided)", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "deprecated": false } }, "/nsa/api/v1/alarms/historicalAlarms/{retentionDate}": { "delete": { "tags": [ "Retrieve and modify alarms (version 1)" ], "summary": "removeOldHistoricalAlarms", "description": "Use with caution!", "operationId": "removeOldHistoricalAlarms", "parameters": [ { "name": "retentionDate", "in": "path", "description": "Removed date in _yyyymmdd_ format", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successfully removed historical alarms", "headers": {}, "content": {} }, "400": { "description": "Bad Request", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "500": { "description": "Removing historical alarms failed (error message provided)", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "deprecated": false } }, "/nsa/api/v1/alarms/historicalChangePartition": { "get": { "tags": [ "Retrieve and modify alarms (version 1)" ], "summary": "getHistoricalChangePartition", "description": "Get configuration of if historical alarms change partition.", "operationId": "getHistoricalChangePartition", "parameters": [], "responses": { "200": { "description": "Successfully return the configured historical change partition", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetentionDaysRO" } } } }, "400": { "description": "Bad Request", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "500": { "description": "Failed to get the historical change partition (error message provided)", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "deprecated": true } }, "/nsa/api/v1/alarms/historicalDataRetentionDays": { "get": { "tags": [ "Retrieve and modify alarms (version 1)" ], "summary": "getHistoricalDataRetentionDays", "description": "Get configuration of historical data retention days.", "operationId": "getHistoricalDataRetentionDays", "parameters": [], "responses": { "200": { "description": "Successfully return the configured historical data retention days", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetentionDaysRO" } } } }, "400": { "description": "Bad Request", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "500": { "description": "Failed to get the historical data retention days (error message provided)", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "deprecated": true } }, "/nsa/api/v1/alarms/historicalDataRetentionDays/{retentionDays}": { "put": { "tags": [ "Retrieve and modify alarms (version 1)" ], "summary": "setHistoricalDataRetentionDays", "description": "Use with caution! The expired data based on the new retention day will be deleted.", "operationId": "setHistoricalDataRetentionDays", "parameters": [ { "name": "retentionDays", "in": "path", "description": "Number of historical data retention days. Must be between 1 - 365", "required": true, "style": "simple", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successfully set the new historical data retention days", "headers": {}, "content": {} }, "400": { "description": "Bad Request", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "500": { "description": "Set the new historical data retention days failed (error message provided)", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "deprecated": true } }, "/nsa/api/v1/alarms/{Id}/acknowledge": { "post": { "tags": [ "Retrieve and modify alarms (version 1)" ], "summary": "acknowledgeAlarmV1", "description": "Only active Alarms can be acknowledged.", "operationId": "acknowledgeAlarmV1", "parameters": [ { "name": "Id", "in": "path", "description": "Identifier of the alarm to be marked as _acknowledged_.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successfully acknowledged alarm", "headers": {}, "content": {} }, "400": { "description": "Bad Request", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "404": { "description": "Alarm not found", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "500": { "description": "Acknowledging a specific active alarm failed (error message provided)", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "deprecated": true } }, "/nsa/api/v1/alarms/{Id}/force-clear": { "post": { "tags": [ "Retrieve and modify alarms (version 1)" ], "summary": "forceClearAlarmV1", "description": "Never use this REST API unless you have no other option.", "operationId": "forceClearAlarmV1", "parameters": [ { "name": "Id", "in": "path", "description": "Identifier of the alarm to be marked as _cleared_.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successfully force cleared alarm", "headers": {}, "content": {} }, "400": { "description": "Bad Request", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "404": { "description": "Alarm not found", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "500": { "description": "Clearing a specific active alarm failed (error message provided)", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "deprecated": true } }, "/nsa/api/v1/alarms/{Id}/manual-clear": { "post": { "tags": [ "Retrieve and modify alarms (version 1)" ], "summary": "manualClearAlarmV1", "description": "Only manually clearable alarms can be cleared.", "operationId": "manualClearAlarmV1", "parameters": [ { "name": "Id", "in": "path", "description": "Identifier of the alarm to be marked as _cleared_.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successfully manually cleared alarm", "headers": {}, "content": {} }, "400": { "description": "Bad Request", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "404": { "description": "Alarm not found", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "500": { "description": "Clearing a specific active alarm failed (error message provided)", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "deprecated": true } }, "/nsa/api/v1/alarms/{Id}/unacknowledge": { "post": { "tags": [ "Retrieve and modify alarms (version 1)" ], "summary": "unacknowledgeAlarmV1", "description": "Only active Alarms can be unacknowledged.", "operationId": "unacknowledgeAlarmV1", "parameters": [ { "name": "Id", "in": "path", "description": "Identifier of the alarm to be marked as _unacknowledged_.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successfully un-acknowledged alarm", "headers": {}, "content": {} }, "400": { "description": "Bad Request", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "404": { "description": "Alarm not found", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "500": { "description": "Un-acknowledging a specific active alarm failed (error message provided)", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "deprecated": true } }, "/nsa/api/v2_0/alarms/alarm-sync-states": { "post": { "tags": [ "Retrieve and modify alarms (version 2)" ], "summary": "getAlarmSyncStates", "description": "Get a collection of alarm sync states of given nodes", "operationId": "getAlarmSyncStates", "parameters": [], "requestBody": { "description": "Alarm query list", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AlarmQueryList" }, { "description": "Alarm query list" } ] } } }, "required": true }, "responses": { "200": { "description": "Successfully retrieved alarm sync states", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NodeAlarmStateRO" } } } }, "500": { "description": "Internal error", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "deprecated": false } }, "/nsa/api/v2_0/alarms/resetRequestId/{serverId}": { "post": { "tags": [ "Retrieve and modify alarms (version 2)" ], "summary": "resetRequestIdsForServerId", "description": "Reset request IDs for all alarms/events for this server ID to zero in order to recover from an early request ID roll over", "operationId": "resetRequestIdsForServerId", "parameters": [ { "name": "serverId", "in": "path", "description": "Requested node Identifier.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successfully reset request IDs", "headers": {}, "content": {} }, "400": { "description": "Bad Request", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "500": { "description": "Failed to reset request IDs (error message provided)", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "deprecated": false } }, "/nsa/api/v2_0/alarms/{Id}/acknowledge/{sequenceId}": { "post": { "tags": [ "Retrieve and modify alarms (version 2)" ], "summary": "acknowledgeAlarm", "description": "Only active Alarms can be acknowledged.", "operationId": "acknowledgeAlarm", "parameters": [ { "name": "Id", "in": "path", "description": "Identifier of the alarm to be marked as _acknowledged_.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "sequenceId", "in": "path", "description": "The alarm's last raise time in milliseconds.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successfully acknowledged alarm", "headers": {}, "content": {} }, "400": { "description": "Bad Request", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "404": { "description": "Alarm not found", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "500": { "description": "Acknowledging a specific active alarm failed (error message provided)", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "deprecated": false } }, "/nsa/api/v2_0/alarms/{Id}/annotate": { "post": { "tags": [ "Retrieve and modify alarms (version 2)" ], "summary": "annotateAlarm", "description": "Only active Alarms can be annotated.", "operationId": "annotateAlarm", "parameters": [ { "name": "Id", "in": "path", "description": "Identifier of the alarm to be marked as _annotated_.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "requestBody": { "description": "Annotation event", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Annotation" }, { "description": "Annotation event" } ] } } }, "required": true }, "responses": { "204": { "description": "Successfully annotate alarm", "headers": {}, "content": {} }, "400": { "description": "Bad Request", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "404": { "description": "Alarm not found", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "500": { "description": "Annotating a specific active alarm failed (error message provided)", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "deprecated": false } }, "/nsa/api/v2_0/alarms/{Id}/force-clear/{sequenceId}": { "post": { "tags": [ "Retrieve and modify alarms (version 2)" ], "summary": "forceClearAlarm", "description": "Never use this REST API unless you have no other option.", "operationId": "forceClearAlarm", "parameters": [ { "name": "Id", "in": "path", "description": "Identifier of the alarm to be marked as _cleared_.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "sequenceId", "in": "path", "description": "The alarm's last raise time in milliseconds.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successfully force cleared alarm", "headers": {}, "content": {} }, "400": { "description": "Bad Request", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "404": { "description": "Alarm not found", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "500": { "description": "Clearing a specific active alarm failed (error message provided)", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "deprecated": false } }, "/nsa/api/v2_0/alarms/{Id}/manual-clear/{sequenceId}": { "post": { "tags": [ "Retrieve and modify alarms (version 2)" ], "summary": "manualClearAlarm", "description": "Only manually clearable alarms can be cleared.", "operationId": "manualClearAlarm", "parameters": [ { "name": "Id", "in": "path", "description": "Identifier of the alarm to be marked as _cleared_.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "sequenceId", "in": "path", "description": "The alarm's last raise time in milliseconds.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successfully manually cleared alarm", "headers": {}, "content": {} }, "400": { "description": "Bad Request", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "404": { "description": "Alarm not found", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "500": { "description": "Clearing a specific active alarm failed (error message provided)", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "deprecated": false } }, "/nsa/api/v2_0/alarms/{Id}/removeAnnotation": { "post": { "tags": [ "Retrieve and modify alarms (version 2)" ], "summary": "removeAnnotation", "description": "Only active Alarms can be annotated.", "operationId": "removeAnnotation", "parameters": [ { "name": "Id", "in": "path", "description": "Identifier of the alarm to be marked as _annotated_.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successfully un-annotated alarm", "headers": {}, "content": {} }, "400": { "description": "Bad Request", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "404": { "description": "Alarm not found", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "500": { "description": "Un-annotating a specific active alarm failed (error message provided)", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "deprecated": false } }, "/nsa/api/v2_0/alarms/{Id}/unacknowledge/{sequenceId}": { "post": { "tags": [ "Retrieve and modify alarms (version 2)" ], "summary": "unacknowledgeAlarm", "description": "Only active Alarms can be unacknowledged.", "operationId": "unacknowledgeAlarm", "parameters": [ { "name": "Id", "in": "path", "description": "Identifier of the alarm to be marked as _unacknowledged_.", "required": true, "style": "simple", "schema": { "type": "string" } }, { "name": "sequenceId", "in": "path", "description": "The alarm's last raise time in milliseconds.", "required": true, "style": "simple", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Successfully un-acknowledged alarm", "headers": {}, "content": {} }, "400": { "description": "Bad Request", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "404": { "description": "Alarm not found", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "500": { "description": "Un-acknowledging a specific active alarm failed (error message provided)", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "deprecated": false } }, "/nsa/api/v1/alarms/filter/activeAlarmCountsBasic": { "get": { "tags": [ "Search and filter alarms (version 1)" ], "summary": "getActiveAlarmCounts", "description": "Query active alarm counts of severity CRITICAL, MAJOR, MINOR and WARNING.", "operationId": "getActiveAlarmCounts", "parameters": [], "responses": { "200": { "description": "Successfully retrieved alarm counts", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredAlarms" } } } }, "400": { "description": "Bad Request", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "500": { "description": "Alarm counts retrieval failed (error message provided)", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "deprecated": false } }, "/nsa/api/v1/alarms/filter/activeAlarms": { "get": { "tags": [ "Search and filter alarms (version 1)" ], "summary": "searchActiveAlarms", "description": "List of active Alarms returned in JSON format.", "operationId": "searchActiveAlarms", "parameters": [ { "name": "severity", "in": "query", "description": "Severity values as a comma separated list. Example: CRITICAL, MAJOR, MINOR, WARNING", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "serviceAffecting", "in": "query", "description": "Service Affecting values as a comma separated list. Example: SERVICE_AFFECTING, NON_SERVICE_AFFECTING", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "deviceType", "in": "query", "description": "Device type values as a comma separated list. Example: OPENSTACK, CN6500, NUAGE", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "acknowledgeState", "in": "query", "description": "Acknowledgment state values as a comma separated list.Example: ACKNOWLEDGED, NOT_ACKNOWLEDGED", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "keytext", "in": "query", "description": "Key text to be present in the supported alarm fields. Supported fields include: condition-severity, node-name, resource, acknowledge-state, native-condition-type, and additional-text. Several operators are available including '+' (AND), '|' (OR), '-' (negate).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "range", "in": "query", "description": "Comma separated last raised time range in format: yyyy-MM-ddTHH:mm:ss.SSS. Example: 1900-01-01T00:00:00.000,2999-12-31T23:59:59.999", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "sorting", "in": "query", "description": "Alarm attribute that the response will be sorted on, such as raiseTime, either in ascending or descending order. Example: last-raise-time:DESC", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Offset for the next page of results. Example: 50", "style": "form", "explode": true, "schema": { "type": "string", "default": "0" } }, { "name": "pageSize", "in": "query", "description": "Limit of the number of alarms present in a page.", "style": "form", "explode": true, "schema": { "type": "string", "default": "500" } } ], "responses": { "200": { "description": "Successfully retrieved filtered list of alarms", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActiveAlarms" } } } }, "400": { "description": "Bad request", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "500": { "description": "Search on alarms failed (error message provided)", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "deprecated": true } }, "/nsa/api/v1/alarms/filter/historicalAlarms": { "get": { "tags": [ "Search and filter alarms (version 1)" ], "summary": "searchHistoricalAlarms", "description": "List of historical cleared Alarms returned in JSON format.", "operationId": "searchHistoricalAlarms", "parameters": [ { "name": "severity", "in": "query", "description": "Severity values as a comma separated list. Example: CRITICAL, MAJOR, MINOR, WARNING", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "serviceAffecting", "in": "query", "description": "Service Affecting values as a comma separated list. Example: SERVICE_AFFECTING, NON_SERVICE_AFFECTING", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "deviceType", "in": "query", "description": "Device type values as a comma separated list. Example: OPENSTACK, CN6500, NUAGE", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "keytext", "in": "query", "description": "Key text to be present in the supported alarm fields. Supported fields include: condition-severity, node-name, resource, acknowledge-state, native-condition-type, and additional-text. Several operators are available including '+' (AND), '|' (OR), '-' (negate).", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "range", "in": "query", "description": "Comma separated clear time range in format: yyyy-MM-ddTHH:mm:ss.SSS. Example: 1900-01-01T0:0:0.000,2999-12-31T23:59:59.999", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "sorting", "in": "query", "description": "Alarm attribute that the response will be sorted on, such as raiseTime, either in ascending or descending order. Example: last-raise-time:DESC", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Offset for the next page of results. Example: 50", "style": "form", "explode": true, "schema": { "type": "string", "default": "0" } }, { "name": "pageSize", "in": "query", "description": "Limit of the number of alarms present in a page.", "style": "form", "explode": true, "schema": { "type": "string", "default": "500" } } ], "responses": { "200": { "description": "Successfully retrieved filtered list of alarms", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HistoricalAlarms" } } } }, "400": { "description": "Bad request", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "500": { "description": "Search on alarms failed (error message provided)", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "deprecated": true } }, "/nsa/api/v2_0/alarms/filter": { "get": { "tags": [ "Search and filter alarms (version 2)" ], "summary": "getAllFilters", "description": "Get all alarm filters active on the system.", "operationId": "getAllFilters", "parameters": [], "responses": { "200": { "description": "Successfully retrieved alarm filters", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Filters" } } } }, "500": { "description": "Filter creation failed", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "deprecated": false }, "post": { "tags": [ "Search and filter alarms (version 2)" ], "summary": "createFilter", "description": "Create a unique Alarm filter.", "operationId": "createFilter", "parameters": [], "requestBody": { "description": "Alarm filter", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Filter" }, { "description": "Alarm filter" } ] } } }, "required": true }, "responses": { "200": { "description": "successful operation", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Filter" } } } }, "201": { "description": "Filter successfully created", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Filter" } } } }, "400": { "description": "Bad Request", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "403": { "description": "Forbidden", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "500": { "description": "Filter creation failed", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "deprecated": false } }, "/nsa/api/v2_0/alarms/filter/activeAlarmCounts": { "get": { "tags": [ "Search and filter alarms (version 2)" ], "summary": "getActiveAlarmCounts", "description": "Query active alarm counts of severity CRITICAL, MAJOR, MINOR and WARNING.", "operationId": "GetgetActiveAlarmCounts", "parameters": [], "responses": { "200": { "description": "Successfully retrieved alarm counts", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilteredAlarms" } } } }, "400": { "description": "Bad Request", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } }, "500": { "description": "Alarm counts retrieval failed (error message provided)", "headers": {}, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Errors" } } } } }, "deprecated": false } }, "/nsa/api/v2_0/alarms/filter/activeAlarms": { "get": { "tags": [ "Search and filter alarms (version 2)" ], "summary": "searchActiveAlarmsV2", "description": "List of active Alarms returned in JSON format.", "operationId": "searchActiveAlarmsV2", "parameters": [ { "name": "filter[severity]", "in": "query", "description": "Severity values as a comma separated list or in new lines.The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...**Example**: _CRITICAL,MAJOR,MINOR,WARNING_", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "filter[serviceAffecting]", "in": "query", "description": "Service affecting values as a comma separated list or in new lines.The latter translates to _filter[key][]=value1&filter[key][]=value2&_ ...**Example**: _SERVICE_AFFECTING,NON_SERVICE_AFFECTING_", "style": "form", "explode": true, "schema": { "type": "string" } }, { "name": "filter[deviceType]", "in": "q