Configuration API for Avaya Session Border Controller for Enterprise (Release 10.2.0.0 / Spec Revision 1.0)

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).

System Information

APIs for viewing system information, including installed applications and statuses.

Get System Overview

Get an overview of the system hardware specifications.

User must have the system-overview:read capability to perform this action.

Responses

Response samples

Content type
application/json
{
  • "cpu": {
    },
  • "memory": {
    },
  • "disk": {
    },
  • "nic": {
    },
  • "bios": {
    },
  • "os": {
    }
}

Get Application Status List

Get a list of applications and the current status.

User must have the application-status:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Get Installed Application List

Get an overview of the system hardware specifications.

User must have the installed-application:read capability to perform this action.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Packet Capture

APIs for managing packet captures.

Get Current Packet Capture Status

Get the current status of packet capture.

User must have the packet-capture:read capability to perform this action.

Responses

Response samples

Content type
application/json
{
  • "capturing": true,
  • "interfaceName": "B2",
  • "localTarget": "*:443",
  • "remoteTarget": "*",
  • "protocol": "*",
  • "packetCaptureLimit": 10000,
  • "captureFilename": "test.pcap"
}

Update Packet Capture Status

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.

Request Body schema: application/json

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.

Responses

Request samples

Content type
application/json
{
  • "capturing": true,
  • "interfaceName": "B2",
  • "localTarget": "*:443",
  • "remoteTarget": "*",
  • "protocol": "*",
  • "packetCaptureLimit": 10000,
  • "captureFilename": "test.pcap"
}

Response samples

Content type
application/json
{
  • "capturing": true,
  • "interfaceName": "B2",
  • "localTarget": "*:443",
  • "remoteTarget": "*",
  • "protocol": "*",
  • "packetCaptureLimit": 10000,
  • "captureFilename": "test.pcap"
}

Get Packet Capture File List

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.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Download Packet Capture File

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.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Delete Packet Capture File

Delete a specific packet capture (.pcap) file from this system.

User must have the packet-capture:delete capability to perform this action.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}