• About the REST APIs
• All REST Endpoints

Get Started

• Quick Start
• Use cURL
• Enable HTTPS
• Authenticate
• Send Requests
• Caveats
• Examples
  • Replace the TLS Certificate
  • Update an Expiring Certificate
  • Modify the Boot Parameters
  • Save, Verify, and Activate the Configuration
  • Set the Hostname
  • Create the Default sip-config Element
  • Create the Default media-manager Element
  • Configure Physical Interfaces
  • Configure Network Interfaces
  • Configure Realms
  • Configure a SIP Interface
  • Monitor CPU
  • Retrieve KPIs
• Reference
  • Status Codes
  • Error Messages

Tasks

• Admin
  • Execute HA switchover
  • Get the status of last asynchronous request
  • Reboot the system
  • Refresh internal tasks
  • Show the next hop for a specific route
• api
  • Get supported REST API versions
• Authentication
  • Request an access token
• Certificates
  • Generates certificate signing request (CSR) for a certificate-record
  • Get certificate details
  • Import a CA-signed certificate
• Configuration
  • Add a single configuration element instance
  • Delete a configuration element and all its references
  • Delete a single configuration element instance
  • Get a list of all supported configuration element types
  • Get a template instance for a configuration element or sub-element type
  • Get one or more configuration element instances
  • Get the boot parameters
  • Get the metadata for a configuration element type
  • Lock the configuration
  • Unlock the configuration
  • Update a single configuration element instance
  • Update the boot parameters
• Configuration Management
  • Back up or activate a configuration
  • Delete current configuration
  • Delete saved backup configuration files
  • Get current and running configuration versions
  • Get list of saved backup configuration files
  • Save, verify or restore a configuration
• Statistics
  • Discover available KPI types or get the KPI schema for a type.
  • Get current HDR collections status
  • Get KPI data
  • Purge collected HDR files
  • Start, stop or restart HDR collection
• System
  • Add a license
  • Delete a license
  • Get features, licenses and product information
  • Get file system storage space information
  • Get hardware entity information
  • Get system information
  • Get system status information
  • Get system version information
  • Set up product type or entitlements