REST API for Session Border Controller, Enterprise Session Border Controller, and Subscriber-Aware Load Balancer, Release 8.4.0

All REST Endpoints

admin

APIs for administrative operations.

Execute HA switchover: Method: post
Path: /rest/{version}/admin/switchover
Get the status of last asynchronous request: Method: get
Path: /rest/{version}/admin/asyncstatus
Reboot the system: Method: post
Path: /rest/{version}/admin/reboot
Refresh internal tasks: Method: post
Path: /rest/{version}/admin/refresh/{task}

api

APIs to retrieve information about the REST API itself.

Get supported REST API versions: Method: get
Path: /rest/api/supportedversions

auth

API for authorization. In this release, the only operation supported is the request (or re-request) of an authorization token, which the client must supply in all subsequent requests.

Request an access token: Method: post
Path: /rest/{version}/auth/token

certificates

APIs related to certificate management. GET requests can be made by a REST client without the configuration lock. But a REST client must possess the configuration lock before making PUT requests either to generate a certificate signing request (CSR) or to import a certificate.

The Subscriber-Aware Load Balancer does not support certificate-related endpoints.

Generate a certificate signing request for a certificate-record: Method: put
Path: /rest/{version}/configuration/certificates/generateRequest
Get certificate details: Method: get
Path: /rest/{version}/configuration/certificates
Import a CA-signed certificate: Method: put
Path: /rest/{version}/configuration/certificates/import

configuration

APIs affecting configuration elements. GET requests can be made by a client without the configuration lock, but any configuration request that changes the system configuration in any way—including saving, restoring, or activating it, plus POST, PUT, and DELETE—requires the REST client to first possess the configuration lock. Acquiring and releasing the lock are themselves both considered configuration operations.

Add a single configuration element instance: Method: post
Path: /rest/{version}/configuration/configElements
Delete a single configuration element instance: Method: delete
Path: /rest/{version}/configuration/configElements
Get a list of all supported configuration element types: Method: get
Path: /rest/{version}/configuration/elementTypes
Get a template instance for a configuration element or sub-element type: Method: get
Path: /rest/{version}/configuration/elementTypes/template
Get one or more configuration element instances: Method: get
Path: /rest/{version}/configuration/configElements
Get the boot parameters: Method: get
Path: /rest/{version}/configuration/bootparams
Get the metadata for a configuration element type: Method: get
Path: /rest/{version}/configuration/elementTypes/metadata
Lock the configuration: Method: post
Path: /rest/{version}/configuration/lock
Unlock the configuration: Method: post
Path: /rest/{version}/configuration/unlock
Update a single configuration element instance: Method: put
Path: /rest/{version}/configuration/configElements
Update the boot parameters: Method: put
Path: /rest/{version}/configuration/bootparams

configuration management

APIs related to management of configuration and configuration files.

Back up or activate a configuration: Method: post
Path: /rest/{version}/configuration/management
Delete current configuration: Method: delete
Path: /rest/{version}/configuration/management
Delete saved backup configuration files: Method: delete
Path: /rest/{version}/configuration/management/files
Get current and running configuration versions: Method: get
Path: /rest/{version}/configuration/versions
Get list of saved backup configuration files: Method: get
Path: /rest/{version}/configuration/management/files
Save, verify or restore a configuration: Method: put
Path: /rest/{version}/configuration/management

statistics

APIs related to statistics, KPIs, and metrics.

Discover available KPI types or get the KPI schema for a type.: Method: get
Path: /rest/{version}/statistics/kpiTypes
Get current HDR collections status: Method: get
Path: /rest/{version}/statistics/collections
Get KPI data: Method: get
Path: /rest/{version}/statistics/kpis
Purge collected HDR files: Method: delete
Path: /rest/{version}/statistics/collections
Start, stop or restart HDR collection: Method: put
Path: /rest/{version}/statistics/collections

system

System level APIs.

Add a license: Method: post
Path: /rest/{version}/system/features
Delete a license: Method: delete
Path: /rest/{version}/system/features
Get features, licenses and product information: Method: get
Path: /rest/{version}/system/features
Get file system storage space information: Method: get
Path: /rest/{version}/system/storage
Get hardware entity information: Method: get
Path: /rest/{version}/system/hardware
Get system information: Method: get
Path: /rest/{version}/system/information
Get system status information: Method: get
Path: /rest/{version}/system/status
Get system version information: Method: get
Path: /rest/{version}/system/version
Set up product type or entitlements: Method: put
Path: /rest/{version}/system/features