Delete Syslog Destination - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"Delete Syslog Destination","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/181eb68a-7ae6-3fee-8588-bdd2b4e91d68","info":{"title":"Crosswork Alarms and Events APIs","description":"Crosswork Alarms and Events APIs allow applications to create, update, acknowledge and clear alarms.","contact":{"name":"Crosswork Team, Cisco","email":"support@cisco.com"},"license":{"name":"Cisco Software License Agreement","url":"https://www.cisco.com/public/sw-license-agreement.html"},"version":"1.0.0"},"x-parser-conf":{"overview":{"markdownPath":"reference/INFRA/FAULT_MANAGEMENT/fault-infra-deprecated-api-overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://{server_ip}:30603/crosswork/alarms/v1","description":"Alarms"}]},"spec":{"tags":["Alarms"],"summary":"Delete Syslog Destination","operationId":"deleteSyslogServer","deprecated":true,"responses":{"200":{"description":"successful response.","content":{"*/*":{"schema":{"title":"Alarm Response","type":"object","description":"Response structure for alarm operations.","properties":{"state":{"description":"The state of the alarm response.","title":"Indicate the outcome of the API operation response invoked on the Alarm Center","type":"string","default":"InvalidState","enum":["InvalidState","Success","Fail","Partial"],"$$ref":"#/components/schemas/alarmsResponseState"},"Message":{"type":"string","description":"Message related to the alarm response."},"eventId":{"type":"string","description":"The identifier of the event related to the response."},"alarmId":{"type":"string","description":"The identifier of the alarm related to the response."},"alarms":{"type":"array","items":{"title":"An Alarm that aggregates several Events & Alarms","type":"object","description":"Representation of an alarm aggregating events and related alarms.","properties":{"AlarmId":{"title":"A unique uuid generated for the alarm","type":"string","description":"The unique identifier for the alarm."},"origin_service_id":{"title":"The origin service id of this event","type":"string","description":"The identifier of the service that generated the event."},"origin_app_id":{"title":"The origin app id of this event","type":"string","description":"The identifier of the application that generated the event."},"object_id":{"title":"The object/model identifier of the faulting event","type":"string","description":"The identifier of the object related to the event."},"object_description":{"title":"The description of the object/model identifier as it should be shown in the GUI","type":"string","description":"A descriptive text to be displayed in user interface."},"event_type":{"title":"Event Type for correlation","type":"integer","format":"int32","description":"The type of the event, used for correlation purposes."},"State":{"title":"Event/Alarm Severity","type":"string","default":"InvalidSeverity","enum":["InvalidSeverity","Clear","Info","Warning","Minor","Major","Critical"],"description":"The severity level of the event or alarm.","$$ref":"#/components/schemas/alarmsSeverity"},"Description":{"type":"string","description":"The alarm description per the latest event."},"Created":{"title":"Time when the alarm was created","type":"string","format":"int64","description":"Timestamp of alarm creation."},"Updated":{"title":"Time when the alarm was last updated","type":"string","format":"int64","description":"Timestamp of the last update to the alarm."},"Closed":{"title":"Time when the alarm was cleared","type":"string","format":"int64","description":"Timestamp of when the alarm was cleared."},"Acknowledge":{"title":"Was the alarm Acknowledge","type":"boolean","description":"Indicates if the alarm was acknowledged."},"AcknowledeBy":{"title":"Who acknowledge the alarm","type":"string","description":"The user or system that acknowledged the alarm."},"AcknowledgeAt":{"title":"When was the alarm acknowledge","type":"string","format":"int64","description":"Timestamp of when the alarm was acknowledged."},"Events":{"title":"Events aggregated under the alarm","type":"array","items":{"title":"An Event structure, an application/service will post this proto as an input for the Alarm Center to create Events and Alarms","type":"object","description":"Details of an event for alarm creation in the Alarm Center.","properties":{"EventId":{"type":"string","description":"Generated uuid to identify uniquely the event. Will be generated by the client lib."},"origin_service_id":{"title":"The origin service id of this event","type":"string","description":"Identifier for the service originating the event."},"origin_app_id":{"title":"The origin app id of this event","type":"string","description":"Identifier for the application originating the event."},"object_id":{"title":"The object/model identifier of the faulting event","type":"string","description":"The identifier of the object related to the event."},"object_description":{"title":"The description of the object/model identifier as it should be shown in the GUI","type":"string","description":"A descriptive text to be displayed in the user interface."},"event_type":{"title":"Event Type for correlation","type":"integer","format":"int32","description":"The type of the event, used for correlation purposes."},"Timestamp":{"type":"string","description":"The time this event was created. Will be filled by the client lib.","format":"int64"},"EventSeverity":{"title":"Event/Alarm Severity","type":"string","default":"InvalidSeverity","enum":["InvalidSeverity","Clear","Info","Warning","Minor","Major","Critical"],"description":"The severity level of the event or alarm.","$$ref":"#/components/schemas/alarmsSeverity"},"Description":{"type":"string","description":"A free text, parametrized, description. Do not need to fill if there is an event type..."},"Params":{"title":"Parameters for the event case Text","type":"object","additionalProperties":{"type":"string"},"description":"Additional parameters for the event."},"CreateBy":{"type":"string","description":"Who created the event, if the user acknowledges the alarm then the source is the same but the creator is not..."},"EventCategory":{"title":"Defines the Category of the Event/Alarm","type":"string","default":"InvalidCategory","enum":["InvalidCategory","System","Network","Audit","Security","External"],"description":"The category assigned to the event or alarm.","$$ref":"#/components/schemas/alarmsCategory"},"Flagging":{"title":"If the event is a flagging event, e.g. raise an alarm","type":"boolean","description":"Indicates if this event is a flagging event."},"alarm_id":{"title":"Alarm ID","type":"string","description":"The identifier for the associated alarm."},"event_case":{"title":"Event case","type":"integer","format":"int32","description":"The case or scenario associated with the event."}},"$$ref":"#/components/schemas/alarmsEvent"},"description":"A list of events associated with this alarm."},"Alarms":{"title":"Alarms correlated to this alarm","type":"array","items":{"$ref":"#/components/schemas/alarmsAlarm","$$ref":"#/components/schemas/alarmsAlarm"},"description":"A list of related alarms."},"AlarmCategory":{"title":"Defines the Category of the Event/Alarm","type":"string","default":"InvalidCategory","enum":["InvalidCategory","System","Network","Audit","Security","External"],"description":"The category assigned to the event or alarm.","$$ref":"#/components/schemas/alarmsCategory"},"Notes":{"title":"Notes","type":"array","items":{"title":"An Event structure, an application/service will post this proto as an input for the Alarm Center to create Events and Alarms","type":"object","description":"Details of an event for alarm creation in the Alarm Center.","properties":{"EventId":{"type":"string","description":"Generated uuid to identify uniquely the event. Will be generated by the client lib."},"origin_service_id":{"title":"The origin service id of this event","type":"string","description":"Identifier for the service originating the event."},"origin_app_id":{"title":"The origin app id of this event","type":"string","description":"Identifier for the application originating the event."},"object_id":{"title":"The object/model identifier of the faulting event","type":"string","description":"The identifier of the object related to the event."},"object_description":{"title":"The description of the object/model identifier as it should be shown in the GUI","type":"string","description":"A descriptive text to be displayed in the user interface."},"event_type":{"title":"Event Type for correlation","type":"integer","format":"int32","description":"The type of the event, used for correlation purposes."},"Timestamp":{"type":"string","description":"The time this event was created. Will be filled by the client lib.","format":"int64"},"EventSeverity":{"title":"Event/Alarm Severity","type":"string","default":"InvalidSeverity","enum":["InvalidSeverity","Clear","Info","Warning","Minor","Major","Critical"],"description":"The severity level of the event or alarm.","$$ref":"#/components/schemas/alarmsSeverity"},"Description":{"type":"string","description":"A free text, parametrized, description. Do not need to fill if there is an event type..."},"Params":{"title":"Parameters for the event case Text","type":"object","additionalProperties":{"type":"string"},"description":"Additional parameters for the event."},"CreateBy":{"type":"string","description":"Who created the event, if the user acknowledges the alarm then the source is the same but the creator is not..."},"EventCategory":{"title":"Defines the Category of the Event/Alarm","type":"string","default":"InvalidCategory","enum":["InvalidCategory","System","Network","Audit","Security","External"],"description":"The category assigned to the event or alarm.","$$ref":"#/components/schemas/alarmsCategory"},"Flagging":{"title":"If the event is a flagging event, e.g. raise an alarm","type":"boolean","description":"Indicates if this event is a flagging event."},"alarm_id":{"title":"Alarm ID","type":"string","description":"The identifier for the associated alarm."},"event_case":{"title":"Event case","type":"integer","format":"int32","description":"The case or scenario associated with the event."}},"$$ref":"#/components/schemas/alarmsEvent"},"description":"Notes related to the alarm."},"AckHist":{"title":"Acknowledge History","type":"array","items":{"title":"An Event structure, an application/service will post this proto as an input for the Alarm Center to create Events and Alarms","type":"object","description":"Details of an event for alarm creation in the Alarm Center.","properties":{"EventId":{"type":"string","description":"Generated uuid to identify uniquely the event. Will be generated by the client lib."},"origin_service_id":{"title":"The origin service id of this event","type":"string","description":"Identifier for the service originating the event."},"origin_app_id":{"title":"The origin app id of this event","type":"string","description":"Identifier for the application originating the event."},"object_id":{"title":"The object/model identifier of the faulting event","type":"string","description":"The identifier of the object related to the event."},"object_description":{"title":"The description of the object/model identifier as it should be shown in the GUI","type":"string","description":"A descriptive text to be displayed in the user interface."},"event_type":{"title":"Event Type for correlation","type":"integer","format":"int32","description":"The type of the event, used for correlation purposes."},"Timestamp":{"type":"string","description":"The time this event was created. Will be filled by the client lib.","format":"int64"},"EventSeverity":{"title":"Event/Alarm Severity","type":"string","default":"InvalidSeverity","enum":["InvalidSeverity","Clear","Info","Warning","Minor","Major","Critical"],"description":"The severity level of the event or alarm.","$$ref":"#/components/schemas/alarmsSeverity"},"Description":{"type":"string","description":"A free text, parametrized, description. Do not need to fill if there is an event type..."},"Params":{"title":"Parameters for the event case Text","type":"object","additionalProperties":{"type":"string"},"description":"Additional parameters for the event."},"CreateBy":{"type":"string","description":"Who created the event, if the user acknowledges the alarm then the source is the same but the creator is not..."},"EventCategory":{"title":"Defines the Category of the Event/Alarm","type":"string","default":"InvalidCategory","enum":["InvalidCategory","System","Network","Audit","Security","External"],"description":"The category assigned to the event or alarm.","$$ref":"#/components/schemas/alarmsCategory"},"Flagging":{"title":"If the event is a flagging event, e.g. raise an alarm","type":"boolean","description":"Indicates if this event is a flagging event."},"alarm_id":{"title":"Alarm ID","type":"string","description":"The identifier for the associated alarm."},"event_case":{"title":"Event case","type":"integer","format":"int32","description":"The case or scenario associated with the event."}},"$$ref":"#/components/schemas/alarmsEvent"},"description":"History of acknowledgments for the alarm."},"events_count":{"title":"Number of events in this alarm","type":"integer","format":"int32","description":"The total number of events associated with this alarm."}},"$$ref":"#/components/schemas/alarmsAlarm"},"description":"List of alarms in the response."},"events":{"type":"array","items":{"title":"An Event structure, an application/service will post this proto as an input for the Alarm Center to create Events and Alarms","type":"object","description":"Details of an event for alarm creation in the Alarm Center.","properties":{"EventId":{"type":"string","description":"Generated uuid to identify uniquely the event. Will be generated by the client lib."},"origin_service_id":{"title":"The origin service id of this event","type":"string","description":"Identifier for the service originating the event."},"origin_app_id":{"title":"The origin app id of this event","type":"string","description":"Identifier for the application originating the event."},"object_id":{"title":"The object/model identifier of the faulting event","type":"string","description":"The identifier of the object related to the event."},"object_description":{"title":"The description of the object/model identifier as it should be shown in the GUI","type":"string","description":"A descriptive text to be displayed in the user interface."},"event_type":{"title":"Event Type for correlation","type":"integer","format":"int32","description":"The type of the event, used for correlation purposes."},"Timestamp":{"type":"string","description":"The time this event was created. Will be filled by the client lib.","format":"int64"},"EventSeverity":{"title":"Event/Alarm Severity","type":"string","default":"InvalidSeverity","enum":["InvalidSeverity","Clear","Info","Warning","Minor","Major","Critical"],"description":"The severity level of the event or alarm.","$$ref":"#/components/schemas/alarmsSeverity"},"Description":{"type":"string","description":"A free text, parametrized, description. Do not need to fill if there is an event type..."},"Params":{"title":"Parameters for the event case Text","type":"object","additionalProperties":{"type":"string"},"description":"Additional parameters for the event."},"CreateBy":{"type":"string","description":"Who created the event, if the user acknowledges the alarm then the source is the same but the creator is not..."},"EventCategory":{"title":"Defines the Category of the Event/Alarm","type":"string","default":"InvalidCategory","enum":["InvalidCategory","System","Network","Audit","Security","External"],"description":"The category assigned to the event or alarm.","$$ref":"#/components/schemas/alarmsCategory"},"Flagging":{"title":"If the event is a flagging event, e.g. raise an alarm","type":"boolean","description":"Indicates if this event is a flagging event."},"alarm_id":{"title":"Alarm ID","type":"string","description":"The identifier for the associated alarm."},"event_case":{"title":"Event case","type":"integer","format":"int32","description":"The case or scenario associated with the event."}},"$$ref":"#/components/schemas/alarmsEvent"},"description":"List of events in the response."},"total":{"type":"string","format":"int64","description":"Total count of items in the response."}},"$$ref":"#/components/schemas/alarmsAlarmResponse"}}}},"default":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"type":"object","description":"Structure representing a runtime error.","properties":{"error":{"type":"string","description":"The error message."},"code":{"type":"integer","format":"int32","description":"The error code."},"message":{"type":"string","description":"A detailed error message."},"details":{"type":"array","items":{"type":"object","description":"A protobuf Any type structure.","properties":{"type_url":{"type":"string","description":"The URL of the type."},"value":{"type":"string","format":"byte","description":"The value of the type."}},"$$ref":"#/components/schemas/protobufAny"},"description":"Additional details about the error."}},"$$ref":"#/components/schemas/runtimeError"}}}}},"parameters":[{"name":"body","in":"query","required":true,"description":"The body of the query parameters.","schema":{"title":"Syslog Destination","type":"object","description":"Configuration details for a Syslog destination.","properties":{"host":{"title":"IPv4 or IPv6 address of the Syslog server","type":"string","description":"The IP address of the Syslog server."},"port":{"title":"Listening port of the Syslog server","type":"integer","format":"int32","description":"The port on which the Syslog server is listening."},"criteria":{"title":"Filter the kind of events that should be forwarded as Syslogs","type":"string","description":"Criteria used to filter events forwarded as Syslogs."},"rate_per_second":{"title":"Rate per second to send the Syslogs","type":"integer","format":"int32","description":"The maximum rate at which Syslogs are sent."},"secure":{"title":"Enable/Disable secure TLS connection","type":"boolean","description":"Indicates if a secure TLS connection is enabled."},"certificate_id":{"title":"Certificate name","type":"string","description":"The ID of the certificate used for secure connections."}},"$$ref":"#/components/schemas/alarmsSyslogDestination"}}],"__originalOperationId":"deleteSyslogServer","method":"delete","path":"/syslog-dest"}}