Web API Reference

CDRouter includes a powerful web API that allows you to automate nearly every aspect of testing and configuration that you can already do through the main CDRouter web GUI.

This documentation describes how to access the REST API directly. For information about the cdrouter.py Python module, please see the following links:

• cdrouter.py module documentation
• example python scripts

The Web API

Each resource type of the CDRouter REST API is covered in a separate article below. Please begin by reading the overview article.

• Overview

Users who wish to launch packages, manage jobs and gather results should read the following articles.

• Configs
• Devices
• Jobs
• Packages
• Results
  • Alerts
  • Test Results
    • Annotations
    • Captures
    • Highlights

Users who wish to perform bulk import/export operations on configs, packages and results should read these articles.

• Imports
• Exports

System management features such as tags, users and the history log are detailed in the articles below.

• History
• System
• Tags
• Testsuites
• Users