• About the REST APIs
• All REST Endpoints

Get Started

• Quick Start
• Use cURL
• Enable HTTPS
• Authenticate
• Send Requests
• Caveats
• Examples
  • Save, Verify, and Activate the Configuration
  • Create A Session Group
  • Create A Session Agent
  • Add A User Number
• Reference
  • Status Codes
  • Error Messages

Tasks

• admin
  • Execute HA switchover
  • Get the status of last asynchronous request
  • Reboot the system
• api
  • Get supported REST API versions
• auth
  • Request an access token
• configuration
  • Add a single configuration element instance
  • 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 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 KPI data
• system
  • Get file system storage space information
  • Get system information
  • Get system status information
  • Get system version information