CDRouter Web API

https://support.qacafe.com/cdrouter/cdrouter-web-api/
Admin
CDRouter Web API is a REST API that allows you to automate testing and configuration management,...
Tokens:155,069
Snippets:565
Trust Score:9.6
Update:5 months ago
Show doc for...
Tokens:
Raw
### Upload and Install Upgrade Manually

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/system

Upgrades CDRouter by uploading a `.bin` installer file. The request must use `multipart/form-data` with the installer file under the 'file' form key. Running tests will be stopped.

```http
POST /api/v1/system/upgrade/
Content-Type: multipart/form-data; boundary=----CBacgHmUVPwinTJL

----CBacgHmUVPwTniJL
Content-Disposition: form-data; name="file"; filename="cdrouter_10.0-2_x86_64.bin"


<.bin file contents...>
----CBacgHmUVPwinTJL--

```

```json
{
    "timestamp": "2016-04-18T11:43:49.684797726-04:00",
    "data": {
        "success": true,
        "output": "<installer-output>..."
    }
}

```

--------------------------------

### Get Highlight Response (404 Not Found)

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/highlights

Example JSON response when a requested highlight is not found. Indicates an error with a descriptive message.

```json
{
    "error": "no such highlight"
}
```

--------------------------------

### Upload & Install Upgrade Manually

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/system

Upgrades CDRouter by uploading a `.bin` installer file. Running tests will be stopped.

```APIDOC
## Upload & Install Upgrade Manually

### Description
Upgrade CDRouter manually by uploading a `.bin` installer from the CDRouter Support Lounge. Please note that any running tests will be stopped.

### Method
POST

### Endpoint
/api/v1/system/upgrade

### Request Body
- **file** (file) - Required - The `.bin` installer file.

### Request Example
Request must have a Content-Type header of `multipart/form-data`. The request body must have a form key named `file` whose contents is the `.bin` installer.
```
POST /api/v1/system/upgrade/
Content-Type: multipart/form-data; boundary=----CBacgHmUVPwinTJL

----CBacgHmUVPwTniJL
Content-Disposition: form-data; name="file"; filename="cdrouter_10.0-2_x86_64.bin"


<.bin file contents...>
----CBacgHmUVPwinTJL--
```

### Response
#### Success Response (200 OK)
```json
{
    "timestamp": "2016-04-18T11:43:49.684797726-04:00",
    "data": {
        "success": true,
        "output": "<installer-output>..."
    }
}
```
```

--------------------------------

### Get preferences

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/system

Retrieves the system preferences from the configuration file.

```APIDOC
## Get preferences
Get preferences from `/usr/cdrouter-data/etc/config.yml`.
GET /api/v1/system/preferences
**Response** `200 OK`
```json
{
    "timestamp": "2016-04-18T14:54:22.10546291-04:00",
    "data": {
        "automatic_login": false,
        "cloudshark_appliance_autotags": "stack,result,host,testcase,passfail,package",
        "cloudshark_appliance_insecure": "yes",
        "cloudshark_appliance_password": "",
        "cloudshark_appliance_tags": "",
        "cloudshark_appliance_token": "",
        "cloudshark_appliance_url": "",
        "cloudshark_appliance_username": "",
        "hostname": "nta3000.local",
        "show_hostname_in_title": false,
        "migrated": [
            "testpaths",
            "configs",
            "packages",
            "results"
        ],
        "port": 80,
        "https": 443,
        "force_https": "no",
        "talkback_port": 8080,
        "use_cloudshark": "no"
    }
}
```
```

--------------------------------

### Download and Install Upgrade from Lounge

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/system

Initiates a download and installation of an upgrade from the CDRouter Support Lounge. Requires user credentials and the release ID obtained from a previous check. Running tests will be stopped.

```json
{
    "email": "my@lounge.email",
    "password": "my_lounge_password",
    "release": {
        "id": 80
    }
}

```

```json
{
    "timestamp": "2016-04-18T15:28:19.139242779-04:00",
    "data": {
        "success": true,
        "output": "<installer-output>..."
    }
}

```

--------------------------------

### Download and Install License from Lounge

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/system

Downloads and installs a license for the CDRouter system from the CDRouter Support Lounge. A successful operation returns a 200 OK status.

```json
{
    "timestamp": "2016-12-07T13:42:34.17472195-05:00",
    "data": {
        "success": true,
        "output": "<cdrouter-cli -update-license output>..."
    }
}

```

--------------------------------

### Create or Edit Highlight Request Example

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/highlights

Example of a PATCH request to create or edit a highlight for a specific line. Requires the highlight's color in the request body.

```http
PATCH /api/v1/results/20160415113526/tests/1/highlights/19/

{
    "color": "yellow"
}
```

--------------------------------

### Download & Install Upgrade from Lounge

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/system

Downloads and installs an upgrade from the CDRouter Support Lounge using provided credentials. Running tests will be stopped.

```APIDOC
## Download & Install Upgrade from Lounge

### Description
Download & install an upgrade from the CDRouter Support Lounge using your Support Lounge email & password. Please note that any running tests will be stopped.

### Method
POST

### Endpoint
/api/v1/system/lounge/upgrade

### Request Body
- **email** (string) - Required - Your Support Lounge email address.
- **password** (string) - Required - Your Support Lounge password.
- **release** (object) - Required - Release information.
  - **id** (integer) - Required - The ID of the release to install, obtained from a successful check upgrade operation.

### Request Example
```json
{
    "email": "my@lounge.email",
    "password": "my_lounge_password",
    "release": {
        "id": 80
    }
}
```

### Response
#### Success Response (200 OK)
```json
{
    "timestamp": "2016-04-18T15:28:19.139242779-04:00",
    "data": {
        "success": true,
        "output": "<installer-output>..."
    }
}
```
```

--------------------------------

### Get New Config

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/configs

Generates a new, default configuration file.

```APIDOC
## GET /api/v1/configs/?template=default

### Description
Get output of `cdrouter-cli -new-config`.

### Method
GET

### Endpoint
/api/v1/configs/?template=default

### Response
#### Success Response (200 OK)
- **timestamp** (string) - The timestamp of the response.
- **data** (string) - The content of the new configuration file.

### Response Example (200 OK)
```json
{
    "timestamp": "2016-04-15T11:17:56.930163989-04:00",
    "data": "SECTION \"About\" {\n\n    # Cable/DSL Router Test Suite\n..."
}
```
```

--------------------------------

### List Logdir Files (response)

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/results

Example response when listing log directory files, showing file names, sizes, and modification times.

```json
{
    "timestamp": "2016-04-14T09:14:50.870012246-04:00",
    "data": [
        {
            "name": "cdrouter_app_100-lan-m.cap",
            "size": 720,
            "modified": "2016-03-29T15:32:01.372010169-04:00"
        },
        {
            "name": "cdrouter_app_100-lan.10-m.cap",
            "size": 720,
            "modified": "2016-03-29T15:41:02.041071458-04:00"
        },
        {
            "name": "cdrouter_app_100-lan.10.cap",
            "size": 720,
            "modified": "2016-03-29T15:41:02.025071367-04:00"
        }
    ]
}
```

--------------------------------

### Get User API Response (Not Found)

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/users

Example JSON response when a requested user is not found.

```json
{
    "error": "no such user"
}

```

--------------------------------

### Copy Multiple Configurations

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/configs

Use this endpoint to create copies of existing configurations. Provide a list of configuration IDs to be duplicated.

```bash
POST /api/v1/configs/?bulk=copy

{
    "configs": [
        {"id": "162"},
        {"id": "127"}
    ]
}
```

--------------------------------

### Get User API Response (Success)

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/users

Example JSON response for a successful retrieval of a single user's details.

```json
{
    "timestamp": "2016-04-15T11:32:16.252824617-04:00",
    "data": {
        "id": "1",
        "admin": true,
        "disabled": false,
        "name": "admin",
        "description": "",
        "created": "2016-01-25T11:51:05.79363-05:00",
        "updated": "2016-04-12T14:28:15.479142-04:00",
        "locked": false,
        "token": "66963dc0"
    }
}

```

--------------------------------

### Bulk Launch All Jobs with Tags

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/jobs

Launch jobs from all packages and apply tags to them. Set the 'all' parameter to 'true' to include all packages and use the 'fields' in the request body to specify tags.

```http
POST /api/v1/jobs/?bulk=launch&all=true
```

```json
{
    "fields": {
        "options": {
            "tags": [
                "monday"
            ]
        }
    }
}
```

--------------------------------

### Get New CDRouter Config Template

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/configs

Retrieves a new configuration based on a specified template, useful for starting new configurations.

```json
{
    "timestamp": "2016-04-15T11:17:56.930163989-04:00",
    "data": "SECTION \"About\" {\n\n    # Cable/DSL Router Test Suite\n..."
}
```

--------------------------------

### Upgrade Multiple Configurations

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/configs

Initiate an upgrade process for a selected set of configurations. Options include migrating to the current NTA platform and applying to all configurations.

```bash
POST /api/v1/configs/?bulk=upgrade&migrate=true

{
    "configs": [
        {
            "id": "5"
        },
        {
            "id": "286"
        }
    ]
}
```

```bash
POST /api/v1/configs/?bulk=upgrade&filter=user_id=3&filter=tags@>{working}
```

```bash
POST /api/v1/configs/?bulk=upgrade&filter=tags@>{vlan,l2tp}
```

```bash
POST /api/v1/configs/?bulk=upgrade&all=true
```

--------------------------------

### Get Testvar Value Completions

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/testsuites

Retrieve a list of possible values or completions for a given testvar. Supports filtering by a starting string and by testvar group.

```http
GET /api/v1/testsuites/{id}/testvars/wanMode/values

```

```http
GET /api/v1/testsuites/{id}/testvars/wanMode/values?match=PPPo

```

```http
GET /api/v1/testsuites/{id}/testvars/permission/values?group=smbuser

```

--------------------------------

### Create or Edit Highlight Response (200 OK)

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/highlights

Example JSON response after successfully creating or editing a highlight. Shows the updated highlight details.

```json
{
    "timestamp": "2016-04-18T10:31:06.212574153-04:00",
    "data": {
        "id": "20160415113526",
        "seq": "1",
        "line": "19",
        "color": "yellow"
    }
}
```

--------------------------------

### Create a New Package

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/packages

Use this endpoint to create a new package. Provide all necessary details in the request body, such as agent ID, test count, test list, user ID, name, configuration ID, device ID, description, tags, options, and scheduling information.

```json
{
    "agent_id": "1",
    "test_count": "517",
    "testlist": [
        "MODULE_basic.tcl",
        "cdrouter_dhcp_server_1",
        "cdrouter_dhcp_server_2",
        "cdrouter_dhcp_server_3",
        "cdrouter_dhcp_server_100",
        "cdrouter_dhcp_server_200",
        "cdrouter_dhcp_server_300",
        "ADDON_IPv6"
    ],
    "user_id": "1",
    "name": "new package",
    "config_id": "6",
    "device_id": "12",
    "description": "package description",
    "tags": [
        "one",
        "two",
        "three"
    ],
    "options": {
        "pause": true,
        "duration": "300",
        "retry": "5"
    },
    "use_as_testlist": false,
    "schedule": {
        "enabled": true,
        "spec": "30 17 * * *",
        "options": {
            "tags": [],
            "skip_tests": [],
            "begin_at": "",
            "end_at": "",
            "extra_cli_args": ""
        }
    }
}
```

```json
{
    "timestamp": "2016-04-15T09:11:30.136008699-04:00",
    "data": {
        "id": "1050",
        "name": "new package",
        "description": "package description",
        "created": "2016-04-15T09:11:30.107517222-04:00",
        "updated": "2016-04-15T09:11:30.107517222-04:00",
        "locked": false,
        "test_count": "517",
        "testlist": [
            "MODULE_basic.tcl",
            "cdrouter_dhcp_server_1",
            "cdrouter_dhcp_server_2",
            "cdrouter_dhcp_server_3",
            "cdrouter_dhcp_server_100",
            "cdrouter_dhcp_server_200",
            "cdrouter_dhcp_server_300",
            "ADDON_IPv6"
        ],
        "extra_cli_args": "",
        "user_id": "1",
        "agent_id": "1",
        "config_id": "6",
        "device_id": "12",
        "options": {
            "forever": false,
            "loop": "0",
            "repeat": "0",
            "maxfail": "0",
            "duration": "300",
            "duration_units": "seconds",
            "duration_interrupt": false,
            "duration_no_error": false,
            "wait": "0",
            "pause": true,
            "shuffle": false,
            "seed": "0",
            "retry": "5",
            "rdelay": "0",
            "sync": false
        },
        "tags": [
            "one",
            "three",
            "two"
        ],
        "use_as_testlist": false,
        "schedule": {
            "enabled": true,
            "spec": "30 17 * * *",
            "options": {
                "tags": [],
                "skip_tests": [],
                "begin_at": "",
                "end_at": "",
                "extra_cli_args": ""
            }
        },
        "interfaces": [
                {
                        "name": "lan",
                        "value": "eth1",
                        "is_wireless": false,
                        "is_ics": false
                },
                {
                        "name": "wan",
                        "value": "eth2",
                        "is_wireless": false,
                        "is_ics": false
                }
        ]
    }
}
```

--------------------------------

### Get Annotation Response (404 Not Found)

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/annotations

Example JSON response when an annotation is not found. This indicates that the requested annotation does not exist for the given test result and sequence.

```json
{
    "error": "no such annotation"
}
```

--------------------------------

### Bulk Copy Devices

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/devices

Use this endpoint to create copies of existing devices. Provide a list of device IDs to be copied.

```bash
POST /api/v1/devices/?bulk=copy
```

```json
{
    "devices": [
        {"id": "1"},
        {"id": "12"}
    ]
}
```

```json
{
    "timestamp": "2016-05-25T11:01:56.470162552-04:00",
    "data": [
        {
            "id": "23",
            "name": "Device Foo (copy 1)",
            "created": "2016-05-24T12:35:21.917593-04:00",
            "updated": "2016-05-25T11:01:56.438313518-04:00",
            "locked": false,
            "user_id": "1",
            "attachments_dir": "/usr/cdrouter-data/attachments/23",
            "picture_id": "22",
            "tags": [],
            "default_ip": "192.168.1.1",
            "default_login": "admin",
            "default_password": "admin",
            "default_ssid": "qacafe",
            "location": "Rack 7",
            "device_category": "",
            "manufacturer": "",
            "manufacturer_oui": "",
            "model_name": "",
            "model_number": "",
            "description": "",
            "product_class": "",
            "serial_number": "",
            "hardware_version": "3.4",
            "software_version": "",
            "provisioning_code": "",
            "note": ""
        },
        {
            "id": "24",
            "name": "Device Bar (copy 1)",
            "created": "2016-05-24T13:22:21.998464-04:00",
            "updated": "2016-05-25T11:01:56.447127497-04:00",
            "locked": false,
            "user_id": "1",
            "attachments_dir": "/usr/cdrouter-data/attachments/24",
            "picture_id": "27",
            "tags": [
                "one"
            ],
            "default_ip": "192.168.178.1",
            "default_login": "qacafe",
            "default_password": "qacafe1234",
            "default_ssid": "qacafe",
            "location": "John's desk",
            "device_category": "wireless router",
            "manufacturer": "Bar Co",
            "manufacturer_oui": "",
            "model_name": "Bar",
            "model_number": "123",
            "description": "Bar Co 123",
            "product_class": "",
            "serial_number": "0005678",
            "hardware_version": "1",
            "software_version": "",
            "provisioning_code": "",
            "note": "This is a wifi gateway with a DSL WAN port."
        }
    ]
}
```

--------------------------------

### Get Annotation Response (200 OK)

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/annotations

Example JSON response for successfully retrieving a single annotation. It contains metadata about the annotation, including its ID, sequence, line number, and comment.

```json
{
    "timestamp": "2016-04-18T10:30:11.327055636-04:00",
    "data": {
        "id": "20160415113526",
        "seq": "1",
        "line": "23",
        "comment": "third comment"
    }
}
```

--------------------------------

### Create a device

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/devices

Creates a new device with the provided details.

```APIDOC
## POST /api/v1/devices/

### Description
Create a new device.

### Method
POST

### Endpoint
/api/v1/devices/

### Parameters
#### Request Body
- **name** (string) - Required - The name of the new device.
- **user_id** (string) - Required - The ID of the user to associate with the device.
- **tags** (array) - Optional - An array of tags for the device.
- **default_ip** (string) - Optional - The default IP address.
- **default_login** (string) - Optional - The default login username.
- **default_password** (string) - Optional - The default password.
- **default_ssid** (string) - Optional - The default SSID.
- **location** (string) - Optional - The physical location of the device.
- **description** (string) - Optional - A description of the device.
- **product_class** (string) - Optional - The product class.
- **serial_number** (string) - Optional - The serial number.
- **hardware_version** (string) - Optional - The hardware version.
- **software_version** (string) - Optional - The software version.
- **provisioning_code** (string) - Optional - The provisioning code.
- **note** (string) - Optional - Additional notes.

### Request Example
```json
{
    "name": "Device Baz2",
    "user_id": "1",
    "tags": [
        "one",
        "three",
        "two"
    ],
    "default_ip": "192.168.1.1",
    "default_login": "admin",
    "default_password": "admin",
    "default_ssid": "qacafe",
    "location": "Rack 7",
    "description": "Baz2 router",
    "product_class": "",
    "serial_number": "",
    "hardware_version": "",
    "software_version": "",
    "provisioning_code": "",
    "note": ""
}
```

### Response
#### Success Response (200 OK)
- **timestamp** (string) - The timestamp of the response.
- **data** (object) - The newly created device object.
  - **id** (string) - The unique identifier for the device.
  - **name** (string) - The name of the device.
  - **created** (string) - The creation timestamp of the device.
  - **updated** (string) - The last update timestamp of the device.
  - **locked** (boolean) - Indicates if the device is locked.
  - **user_id** (string) - The ID of the user associated with the device.
  - **attachments_dir** (string) - The directory for device attachments.
  - **picture_id** (string) - The ID of the associated picture.
  - **tags** (array) - An array of tags associated with the device.
  - **default_ip** (string) - The default IP address of the device.
  - **default_login** (string) - The default login username for the device.
  - **default_password** (string) - The default password for the device.
  - **default_ssid** (string) - The default SSID for the device.
  - **location** (string) - The physical location of the device.
  - **device_category** (string) - The category of the device.
  - **manufacturer** (string) - The manufacturer of the device.
  - **manufacturer_oui** (string) - The manufacturer's OUI.
  - **model_name** (string) - The model name of the device.
  - **model_number** (string) - The model number of the device.
  - **description** (string) - A description of the device.
  - **product_class** (string) - The product class of the device.
  - **serial_number** (string) - The serial number of the device.
  - **hardware_version** (string) - The hardware version of the device.
  - **software_version** (string) - The software version of the device.
  - **provisioning_code** (string) - The provisioning code for the device.
  - **note** (string) - Additional notes about the device.

### Response Example
```json
{
    "timestamp": "2016-05-25T10:58:39.816039365-04:00",
    "data": {
        "id": "22",
        "name": "Device Baz2",
        "created": "2016-05-25T10:58:39.792938857-04:00",
        "updated": "2016-05-25T10:58:39.793886912-04:00",
        "locked": false,
        "user_id": "1",
        "attachments_dir": "/usr/cdrouter-data/attachments/22",
        "picture_id": "0",
        "tags": [
            "one",
            "three",
            "two"
        ],
        "default_ip": "192.168.1.1",
        "default_login": "admin",
        "default_password": "admin",
        "default_ssid": "qacafe",
        "location": "Rack 7",
        "device_category": "",
        "manufacturer": "",
        "manufacturer_oui": "",
        "model_name": "",
        "model_number": "",
        "description": "Baz2 router",
        "product_class": "",
        "serial_number": "",
        "hardware_version": "",
        "software_version": "",
        "provisioning_code": "",
        "note": ""
    }
}
```
```

--------------------------------

### Get Highlight Response (200 OK)

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/highlights

Example JSON response for a successful request to retrieve a specific highlight by its line number. Includes details like ID, sequence, line, and color.

```json
{
    "timestamp": "2016-04-18T10:30:11.327055636-04:00",
    "data": {
        "id": "20160415113526",
        "seq": "1",
        "line": "23",
        "color": "red"
    }
}
```

--------------------------------

### Get Test Result Metric as CSV

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/test-results

Retrieves a specific test result metric in CSV format. This endpoint is available starting from CDRouter 13.13. Available metrics include `bandwidth`, `latency`, `client_bandwidth`, `client_latency`, and `rvr`. These metrics are used by the CDRouter Web UI for performance graphs.

```APIDOC
## GET /api/v1/results/{id}/tests/{seq}/metrics/{metric}/?format=csv

### Description
Get a test result’s metric as CSV. Available metrics are `bandwidth`, `latency`, `client_bandwidth`, `client_latency`, and `rvr`. Metrics are used by the CDRouter Web UI to generate performance graphs.

### Method
GET

### Endpoint
/api/v1/results/{id}/tests/{seq}/metrics/{metric}/

### Parameters
#### Query Parameters
- **format** (string) - Required - Must be `csv`.

### Request Example
```
GET /api/v1/results/20160219125014/tests/2/metrics/bandwidth/?format=csv
```

### Response
#### Success Response (200)
- **Content-Type**: text/csv
- **Content-Disposition**: inline; filename="perf_multi_1_bandwidth_graph.csv"

### Response Example
```csv
perf_multi_1.txt,1677619528272,bandwidth,9416.018,Mbits/sec,PASS,lan.*,wan,10,TCP,download,0,Percentage,0,0
perf_multi_1.2.txt,1677619771178,bandwidth,9415.984,Mbits/sec,PASS,lan.*,wan,10,TCP,download,0,Percentage,0,0
perf_multi_1.3.txt,1677620014136,bandwidth,9415.923,Mbits/sec,PASS,lan.*,wan,10,TCP,download,0,Percentage,0,0
```
```

--------------------------------

### Integer/Date Field Filter Example

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/overview

Example of filtering integer or date fields using the '>' operator.

```http
?filter=passed>10
```

--------------------------------

### Create Config

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/configs

Creates a new configuration with specified contents, name, description, and tags.

```APIDOC
## POST /api/v1/configs/

### Description
Create a new config.

### Method
POST

### Endpoint
/api/v1/configs/

### Request Body
- **contents** (string) - Required - The content of the configuration file.
- **name** (string) - Required - The name of the new config.
- **description** (string) - Optional - A description for the new config.
- **tags** (array) - Optional - An array of tags for the new config.

### Request Example
```json
{
    "contents": "testvar lanIp 192.168.1.1\ntestvar wanMode PPPoE\n",
    "name": "new config",
    "description": "my new config",
    "tags": [
        "one",
        "two",
        "three"
    ]
}
```

### Response
#### Success Response (200 OK)
- **timestamp** (string) - The timestamp of the response.
- **data** (object) - The newly created config object.
  - **id** (string) - The unique identifier for the config.
  - **name** (string) - The name of the config file.
  - **description** (string) - A description of the config.
  - **created** (string) - The creation timestamp of the config.
  - **updated** (string) - The last updated timestamp of the config.
  - **locked** (boolean) - Indicates if the config is locked.
  - **contents** (string) - The content of the configuration file.
  - **user_id** (string) - The ID of the user who created the config.
  - **tags** (array) - An array of tags associated with the config.
  - **note** (string) - A note associated with the config.
  - **interfaces** (array) - An array of network interfaces.
    - **name** (string) - The name of the interface.
    - **value** (string) - The value of the interface.
    - **is_wireless** (boolean) - Indicates if the interface is wireless.
    - **is_ics** (boolean) - Indicates if the interface is part of ICS.
  - **nta_platform** (string) - The NTA platform associated with the config.

### Response Example (200 OK)
```json
{
    "timestamp": "2016-04-15T10:22:57.215100915-04:00",
    "data": {
        "id": "1017",
        "name": "new config",
        "description": "my new config",
        "created": "2016-04-15T10:22:57.17705281-04:00",
        "updated": "2016-04-15T10:22:57.17705281-04:00",
        "locked": false,
        "contents": "testvar lanIp 192.168.1.1\ntestvar wanMode PPPoE\n",
        "user_id": "1",
        "tags": [
            "one",
            "three",
            "two"
        ],
        "note": "",
        "interfaces": [
                {
                        "name": "lan",
                        "value": "eth1",
                        "is_wireless": false,
                        "is_ics": false
                },
                {
                        "name": "wan",
                        "value": "eth2",
                        "is_wireless": false,
                        "is_ics": false
                }
        ],
        "nta_platform": "NTA3000"
    }
}
```
```

--------------------------------

### String Field Filter Example

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/overview

Example of filtering string fields using the '=' operator.

```http
?filter=name=default.conf
```

--------------------------------

### Launch a job with options

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/jobs

Use this endpoint to launch a new job with specific overrides for package defaults. It allows for detailed configuration of test execution, including start/end points, skipped tests, and test variable modifications.

```http
POST /api/v1/jobs/
```

```json
{
    "package_id": "123",
    "device_id": "12",
    "config_id": "34",
    "options": {
        "tags": [
            "one",
            "two"
        ],
        "skip_tests": [
            "cdrouter_basic_1",
            "cdrouter_basic_10"
        ],
        "begin_at": "cdrouter_nat_1",
        "end_at": "cdrouter_nat_2",
        "testvars": [
           {
              "group": "main",
              "name": "lanSSID",
              "value": "qa-net-guest",
           },
           {
              "group": "lan2",
              "name": "lanSSID",
              "value": "qa-net-guest",
           },
           {
              "group": "main",
              "name": "lanClients",
              "action": "delete-testvar"
           },
           {
              "group": "lan3",
              "name": "lanClients",
              "action": "delete-testvar"
           },
           {
              "group": "lan4",
              "action": "delete-group"
           }
        ],
        "extra_cli_args": ""
    }
}
```

--------------------------------

### Download & Install License from Lounge

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/system

Downloads and installs a license for the CDRouter system from the CDRouter Support Lounge.

```APIDOC
## Download & Install License from Lounge

### Description
Download & install a license for your CDRouter system from the CDRouter Support Lounge.

### Method
POST

### Endpoint
/api/v1/system/license

### Response
#### Success Response (200 OK)
```json
{
    "timestamp": "2016-12-07T13:42:34.17472195-05:00",
    "data": {
        "success": true,
        "output": "<cdrouter-cli -update-license output>..."
    }
}
```
```

--------------------------------

### Create Device Response Body

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/devices

Example JSON response upon successful creation of a new device, including its assigned ID and details.

```json
{
    "timestamp": "2016-05-25T10:58:39.816039365-04:00",
    "data": {
        "id": "22",
        "name": "Device Baz2",
        "created": "2016-05-25T10:58:39.792938857-04:00",
        "updated": "2016-05-25T10:58:39.793886912-04:00",
        "locked": false,
        "user_id": "1",
        "attachments_dir": "/usr/cdrouter-data/attachments/22",
        "picture_id": "0",
        "tags": [
            "one",
            "three",
            "two"
        ],
        "default_ip": "192.168.1.1",
        "default_login": "admin",
        "default_password": "admin",
        "default_ssid": "qacafe",
        "location": "Rack 7",
        "device_category": "",
        "manufacturer": "",
        "manufacturer_oui": "",
        "model_name": "",
        "model_number": "",
        "description": "Baz2 router",
        "product_class": "",
        "serial_number": "",
        "hardware_version": "",
        "software_version": "",
        "provisioning_code": "",
        "note": ""
    }
}

```

--------------------------------

### Get System Hostname

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/system

Retrieves the system's hostname. An optional `autodetect` parameter can be provided to get the hostname from the OS.

```json
{
    "timestamp": "2016-04-18T14:54:14.318461608-04:00",
    "data": "nta3000.local"
}
```

--------------------------------

### Create User API Response

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/users

Example JSON response after successfully creating a new user.

```json
{
    "timestamp": "2016-04-15T11:38:47.449193869-04:00",
    "data": {
        "id": "310",
        "admin": false,
        "disabled": false,
        "name": "newuser",
        "description": "my new user",
        "created": "2016-04-15T11:38:47.403281794-04:00",
        "updated": "2016-04-15T11:38:47.403281794-04:00",
        "locked": false,
        "token": "0ea01300"
    }
}

```

--------------------------------

### Get Device Shares (GET)

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/devices

Retrieve the sharing information for a specific device. This includes which users have read, write, or execute permissions.

```json
{
    "timestamp": "2016-04-15T10:00:22.32676552-04:00",
    "data": [
        {
            "user_id": "307",
            "read": true,
            "write": false,
            "execute": false
        },
        {
            "user_id": "309",
            "read": true,
            "write": false,
            "execute": false
        }
    ]
}
```

--------------------------------

### Stage an import from a filesystem path

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/imports

Stages a new import by specifying a filesystem path on the CDRouter system. The `path` query parameter is required.

```APIDOC
## POST /api/v1/imports/?path

### Description
Stage an import from a filesystem path.

### Method
POST

### Endpoint
/api/v1/imports/

### Parameters
#### Query Parameters
- **path** (string) - Required - Filesystem path on the CDRouter system to the import archive.

### Request Example
```http
POST /api/v1/imports/?path=/tmp/upload.gz
```

### Response
#### Success Response (200)
- **timestamp** (string) - The timestamp of the response.
- **data** (object) - The staged import object.
  - **id** (string) - The unique identifier for the import.
  - **user_id** (string) - The ID of the user who initiated the import.
  - **created** (string) - The timestamp when the import was created.
  - **updated** (string) - The timestamp when the import was last updated.
  - **archive** (string) - The name of the archive file.
  - **path** (string) - The filesystem path of the import file.
  - **url** (string) - The URL from which the import was staged.
  - **insecure** (boolean) - Indicates if the connection was insecure.
  - **size** (integer) - The size of the import file.

#### Response Example
```json
{
    "timestamp": "2016-04-18T11:43:49.684797726-04:00",
    "data": {
        "id": "1",
        "user_id": "1",
        "created": "2016-04-18T11:39:00.267967449-04:00",
        "updated": "2016-04-18T11:39:00.267967449-04:00",
        "archive": "upload.gz",
        "path": "",
        "url": "",
        "insecure": false,
        "size": 45594
    }
}
```
```

--------------------------------

### Response for Bulk Job Launch

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/jobs

This is an example of a successful response (200 OK) after a bulk job launch operation. It includes details of the launched jobs.

```json
{
    "timestamp": "2016-08-15T13:35:58.912810418-04:00",
    "data": [
        {
            "id": "178",
            "active": false,
            "status": "pending",
            "options": {
                "tags": null,
                "skip_tests": null,
                "begin_at": "",
                "end_at": "",
                "testvars": [],
                "extra_cli_args": ""
            },
            "package_id": "286",
            "package_name": "all",
            "device_id": "0",
            "device_name": "",
            "config_id": "0",
            "config_name": "",
            "user_id": "1",
            "created": "2016-08-15T13:35:58.075165876-04:00",
            "updated": "2016-08-15T13:35:58.075165876-04:00",
            "automatic": false,
            "run_at": "2016-08-15T13:35:58.075165876-04:00",
            "interfaces": [
                    {
                            "value": "eth2",
                            "is_wireless": false,
                            "is_ics": false
                    },
                    {
                            "value": "wifi1-ax24",
                            "is_wireless": true,
                            "is_ics": false
                    }
            ],
            "interface_names": [
                    "eth2",
                    "wifi1-ax24"
            ],
            "uses_wireless": true,
            "uses_ics": false
        },
        {
            "id": "179",
            "active": false,
            "status": "pending",
            "options": {
                "tags": null,
                "skip_tests": null,
                "begin_at": "",
                "end_at": "",
                "testvars": [],
                "extra_cli_args": ""
            },
            "package_id": "1051",
            "package_name": "all (copy 1)",
            "device_id": "0",
            "device_name": "",
            "config_id": "0",
            "config_name": "",
            "user_id": "1",
            "created": "2016-08-15T13:35:58.16485173-04:00",
            "updated": "2016-08-15T13:35:58.16485173-04:00",
            "automatic": false,
            "run_at": "2016-08-15T13:35:58.16485173-04:00",
            "interfaces": [
                    {
                            "value": "eth2",
                            "is_wireless": false,
                            "is_ics": false
                    },
                    {
                            "value": "wifi1-ax24",
                            "is_wireless": true,
                            "is_ics": false
                    }
            ],
            "interface_names": [
                    "eth2",
                    "wifi1-ax24"
            ],
            "uses_wireless": true,
            "uses_ics": false
        },
        {
            "id": "180",
            "active": false,
            "status": "pending",
            "options": {
                "tags": null,
                "skip_tests": null,
                "begin_at": "",
                "end_at": "",
                "testvars": [],
                "extra_cli_args": ""
            },
            "package_id": "1232",
            "package_name": "all (copy 2)",
            "device_id": "0",
            "device_name": "",
            "config_id": "0",
            "config_name": "",
            "user_id": "1",
            "created": "2016-08-15T13:35:58.254139084-04:00",
            "updated": "2016-08-15T13:35:58.254139084-04:00",
            "automatic": false,
            "run_at": "2016-08-15T13:35:58.254139084-04:00",
            "interfaces": [
                    {
                            "value": "eth2",
                            "is_wireless": false,
                            "is_ics": false
                    },
                    {
                            "value": "wifi1-ax24",
                            "is_wireless": true,
                            "is_ics": false
                    }
            ],
            "interface_names": [
                    "eth2",
                    "wifi1-ax24"
            ],
            "uses_wireless": true,
            "uses_ics": false
        }
    ]
}
```

--------------------------------

### Edit User Request Example

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/users

Example of a PATCH request to edit a user's details. The request body contains the fields to be updated.

```http
PATCH /api/v1/users/123/

{
    "admin": false,
    "disabled": false,
    "name": "olduser",
    "description": "my old user",
}

```

--------------------------------

### Launch a new job

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/jobs

Use this endpoint to launch a new job. Specify the package ID in the request body. This is a POST request to the /api/v1/jobs/ endpoint.

```bash
POST /api/v1/jobs/
```

```json
{
    "package_id": "123"
}
```

--------------------------------

### Bulk Launch Jobs with Tags by Package ID

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/jobs

Launch jobs by package ID and assign tags to them. The 'options' field in the job object allows for specifying tags.

```http
POST /api/v1/jobs/?bulk=launch
```

```json
{
    "jobs": [
        {
            "package_id": "123",
            "options": {
                "tags": [
                    "red"
                ]
            }
        },
        {
            "package_id": "456",
            "options": {
                "tags": [
                    "blue"
            ]
            }
        }
    ]
}
```

--------------------------------

### Change User Password Request Example

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/users

Example of a POST request to change a user's password. The 'old' field can be omitted by an admin. 'new' and 'new_confirm' must match.

```http
POST /api/v1/users/123/password

{
    "old": "old-password",
    "new": "new-password",
    "new_confirm": "new-password"
}

```

--------------------------------

### Bulk Delete All Configs

Source: https://support.qacafe.com/cdrouter/cdrouter-web-api/configs

Use the 'all=true' parameter to delete all configurations. This action is irreversible.

```http
POST /api/v1/configs/?bulk=delete&all=true
```
Tokens:
Raw