Download OpenAPI specification:Download
This is the Monitoring API definition for the Avaya Session Border Controller for Enterprise.
Each supported endpoint is defined in this file along with a description of the endpoint, any required parameters, permissions, and the expected responses with examples. Detailed information on how to fully configure a system from start to finish can be found in the Administering Avaya Session Border Controller for Enterprise document available on the Avaya Support site (see https://support.avaya.com/products/P0997/avaya-session-border-controller-for-enterprise/).
Note that each endpoint definition also includes an embedded x-required-capability
property which contains the
required permissions for the endpoint (this is also included in the description).
APIs for viewing system information, including installed applications and statuses.
Get an overview of the system hardware specifications.
User must have the system-overview:read
capability to perform this action.
{- "cpu": {
- "model": "Intel(R) Xeon(R) Gold 6132 CPU @ 2.60GHz",
- "coreCount": 4,
- "clockSpeedMhz": 2593.906
}, - "memory": {
- "totalBytes": 8070332416,
- "usedBytes": 1170894848,
- "freeBytes": 2871324672
}, - "disk": {
- "partitions": {
- "/": {
- "mountPoint": "/",
- "size": "5.9G",
- "percentUsed": "45%",
- "usedRawGb": 2.5,
- "availableRawGb": 3.1
}, - "/home": {
- "mountPoint": "/home",
- "size": "3.9G",
- "percentUsed": "2%",
- "usedRawGb": 0.064453125,
- "availableRawGb": 3.6
}, - "/boot": {
- "mountPoint": "/boot",
- "size": "488M",
- "percentUsed": "38%",
- "usedRawGb": 0.16503906,
- "availableRawGb": 0.2763672
}, - "/usr/local": {
- "mountPoint": "/usr/local",
- "size": "7.8G",
- "percentUsed": "27%",
- "usedRawGb": 2,
- "availableRawGb": 5.5
}, - "/archive": {
- "mountPoint": "/archive",
- "size": "95G",
- "percentUsed": "1%",
- "usedRawGb": 0.034179688,
- "availableRawGb": 90
}, - "/var": {
- "mountPoint": "/var",
- "size": "27G",
- "percentUsed": "1%",
- "usedRawGb": 0.203125,
- "availableRawGb": 25
}, - "/tmp": {
- "mountPoint": "/tmp",
- "size": "3.9G",
- "percentUsed": "1%",
- "usedRawGb": 0.00020599365,
- "availableRawGb": 3.7
}, - "/root2": {
- "mountPoint": "/root2",
- "size": "5.9G",
- "percentUsed": "1%",
- "usedRawGb": 0.000022888184,
- "availableRawGb": 5.6
}, - "/var/log": {
- "mountPoint": "/var/log",
- "size": "3.9G",
- "percentUsed": "5%",
- "usedRawGb": 0.14648438,
- "availableRawGb": 3.5
}, - "/boot/efi": {
- "mountPoint": "/boot/efi",
- "size": "511M",
- "percentUsed": "2%",
- "usedRawGb": 0.0056640627,
- "availableRawGb": 0.49414062
}, - "/var/log/audit": {
- "mountPoint": "/var/log/audit",
- "size": "2.0G",
- "percentUsed": "55%",
- "usedRawGb": 0.9736328,
- "availableRawGb": 0.8125
}
}
}, - "nic": {
- "count": 6
}, - "bios": {
- "vendor": "VMware, Inc.",
- "version": "VMW71.00V.11599183.B64.1901030933"
}, - "os": {
- "name": "Red Hat Enterprise Linux",
- "version": "8.4 (Ootpa)",
- "bootMode": "UEFI",
- "kernel": {
- "name": "Linux",
- "release": "4.18.0-477.13.1.el8_8.x86_64",
- "version": "#1 SMP Thu May 18 10:27:05 EDT 2023"
}
}
}
Get a list of applications and the current status.
User must have the application-status:read
capability to perform this action.
[- {
- "name": "sshd",
- "displayName": "Secure Shell",
- "type": "SERVICE",
- "enabled": true,
- "running": true,
- "memoryUsage": 0.1,
- "memoryUsageRaw": 7876608,
- "cpuUsage": 0,
- "startTime": "2023-09-26T15:00:40Z",
- "uptime": "PT168H46M22S"
}, - {
- "name": "ipcs_pcf",
- "displayName": "PCF",
- "type": "KERNEL",
- "enabled": true,
- "running": true
}
]
Get an overview of the system hardware specifications.
User must have the installed-application:read
capability to perform this action.
[- {
- "packageName": "kernel",
- "displayName": "Kernel",
- "version": "4.18.0-477.13.1.el8_8"
}, - {
- "packageName": "pcf-module",
- "displayName": "PCF Module",
- "version": "10.2.0.0-23480"
}
]
Get the current status of packet capture.
User must have the packet-capture:read
capability to perform this action.
{- "capturing": true,
- "interfaceName": "B2",
- "localTarget": "*:443",
- "remoteTarget": "*",
- "protocol": "*",
- "packetCaptureLimit": 10000,
- "captureFilename": "test.pcap"
}
Start or stop a packet capture.
WARNING: Starting or stopping packet capture in quick succession. It is recommended to wait at least 5-10 seconds after starting a capture before attempting to stop it.
Note: While running a packet capture, all fields except the capturing
field will be ignored as changing
settings during an active capture is not supported.
User must have the packet-capture:update
capability to perform this action.
Parameters to use to configure the packet capture. All parameters are optional, however all parameters except
capturing
will be ignored while a packet capture is active.
capturing | boolean Current status of the packet capture (is it currently capturing?) |
interfaceName | string Name of the interface the packet capture will be performed on. |
localTarget | string Local IP the packet capture will listen on. Note: This should be a valid IP address or a valid IP and port combination. A wildcard value is allowed here to listen on any IP address (or to only listen on a specific port). |
remoteTarget | string Remote IP the packet capture will listen on. Note: This should be a valid IP address or a valid IP and port combination. A wildcard value is allowed here to listen on any IP address (or to only listen on a specific port). |
protocol | string Enum: "ANY" "TCP" "UDP" Protocol the packet capture will listen on. |
packetCaptureLimit | integer <int32> Number of packets to capture before the capture will stop. Note: Capturing more than 10,000 packets may have an adverse effect on application performance. |
captureFilename | string Name of the output capture file name. Note: The extension is not required and may be omitted. |
{- "capturing": true,
- "interfaceName": "B2",
- "localTarget": "*:443",
- "remoteTarget": "*",
- "protocol": "*",
- "packetCaptureLimit": 10000,
- "captureFilename": "test.pcap"
}
{- "capturing": true,
- "interfaceName": "B2",
- "localTarget": "*:443",
- "remoteTarget": "*",
- "protocol": "*",
- "packetCaptureLimit": 10000,
- "captureFilename": "test.pcap"
}
Get a list of packet capture (.pcap
) files current available on this system.
User must have the packet-capture:read
capability to perform this action.
[- {
- "name": "string",
- "size": 0,
- "lastModified": "2019-08-24T14:15:22Z"
}
]
Get the contents of a specific packet capture (.pcap
) file on this system.
Note: This API directly returns .pcap
files in binary format and should be handled accordingly.
User must have the packet-capture:read
capability to perform this action.
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}
Delete a specific packet capture (.pcap
) file from this system.
User must have the packet-capture:delete
capability to perform this action.
{- "error": {
- "code": 400,
- "message": "Bad request",
- "status": "CONFIGURATION_FAILED"
}
}