Skip to content

Test Nodes

Get Test Node Details

/api/v2/testnodes/{id} 📋 Copied! ▼

Role: Guest and above.

Parameters

Name Description
id * Numeric ID of the Test Node.
Type: integer (path)

Responses

Code Description
200

Test Node data.

Media type: application/json

Example Value:

{
"id": 0,
"name": "string",
"label": "string",
"projects": [
    {
        "id": 0,
        "name": "string"
    }
]
}
404

Resource was not found.

Update a Test Node

/api/v2/testnodes/{id} 📋 Copied! ▼

Role: Admin, or the user who created the Test Node.

name is required (at least 5 characters) and must be unique.

Parameters

Name Description
id * Numeric ID of the Test Node.
Type: integer (path)

Request body *

{
"name": "string"
}

Responses

Code Description
200

Test Node was updated successfully.
404

Resource was not found.
409

Another Test Node already has this name.

Execution Action on a Test Node

/api/v2/testnodes/{id}/action 📋 Copied! ▼

Role: Admin.

command is RESTART_AGENT or UPDATE_AGENT.

Parameters

Name Description
id * Numeric ID of the Test Node.
Type: integer (path)

Request body *

{
"command": "RESTART_AGENT",
"params": "string"
}

Responses

Code Description
200

The command was sent. status is 200 when the node carried it out and 500 when it failed; result and error carry the node's answer.

Media type: application/json

Example Value:

{
"status": 200,
"result": {
},
"error": {
}
}
400

Unknown command.
404

Resource was not found.
500

The command could not be sent.

List Test Nodes

/api/v2/testnodes 📋 Copied! ▼

Role: Guest and above.

Parameters

Name Description
page Zero-based page number. Default 0.
Type: integer (query)
size Page size. Default 20.
Type: integer (query)
sort <field>,asc or <field>,desc.
Type: string (query)
prj Only return items assigned to these projects: comma-separated project IDs.
Type: string (query)

Responses

Code Description
200

A page of Test Nodes.

Media type: application/json

Example Value:

{
"content": [
    {
        "id": 0,
        "name": "string",
        "label": "string",
        "projects": [
            {
                "id": 0,
                "name": "string"
            }
        ]
    }
],
"totalElements": 0,
"totalPages": 0,
"number": 0,
"size": 20
}

Create a Test Node

/api/v2/testnodes 📋 Copied! ▼

Role: Admin.

name is required (at least 5 characters). To install the agent on the machine, use Agent Installer on the Test Nodes page of the Web UI.

Request body *

{
"name": "string"
}

Responses

Code Description
201

ID of the Test Node.

Media type: application/json

Example Value:

{
"id": 0
}
409

Name needs to be unique.

Check Status of Test Node

/api/v2/testnodes/{id}/status 📋 Copied! ▼

Role: Guest and above.

Parameters

Name Description
id * Numeric ID of the Test Node.
Type: integer (path)

Responses

Code Description
200

Whether the node answered.

Media type: application/json

Example Value:

{
"success": true,
"message": "string"
}
404

Resource was not found.

Get Information for Test Nodes

/api/v2/testnodes/info 📋 Copied! ▼

Role: Guest and above.

Responses

Code Description
200

What each agent last reported: its version and network location (agentData) and the devices it sees with their state (agentDetailedData). Fields the agent has not reported are null.

Media type: application/json

Example Value:

{
"data": [
    {
        "testNodeId": 0,
        "testNodeLabel": "string",
        "testNodeName": "string",
        "agentData": {
            "created": "string",
            "ipInfo": {
                "ip": "string",
                "hostname": "string",
                "city": "string",
                "region": "string",
                "country": "string",
                "timezone": "string"
            },
            "version": "string",
            "fleetManagerNodeId": "string"
        },
        "agentDetailedData": {
            "created": "string",
            "devices": [
                {
                    "id": 0,
                    "name": "string",
                    "deviceId": "string",
                    "state": "string",
                    "data": {
                    }
                }
            ],
            "housekeeping": [
            ],
            "stats": {
            },
            "nodeInformation": {
            }
        }
    }
]
}

Get Test Node uptime

/api/v2/testnodes/{id}/uptime 📋 Copied! ▼

Role: Guest and above.

Parameters

Name Description
id * Numeric ID of the Test Node.
Type: integer (path)

Responses

Code Description
200

The node's current state and how long it has been in it. status is UP, DOWN or UNKNOWN; time is a human-readable duration, for example 1 day 3 minutes.

Media type: application/json

Example Value:

{
"status": "UP",
"time": "1 day 3 minutes"
}
404

Resource was not found.

List mobile devices assigned to this Test Node

/api/v2/testnodes/{id}/mobiledevices 📋 Copied! ▼

Role: Guest and above.

Parameters

Name Description
id * Numeric ID of the Test Node.
Type: integer (path)
page Zero-based page number. Default 0.
Type: integer (query)
size Page size. Default 20.
Type: integer (query)
sort <field>,asc or <field>,desc.
Type: string (query)

Responses

Code Description
200

A page of the Mobile Devices connected to this node.

Media type: application/json

Example Value:

{
"content": [
    {
        "id": 0,
        "name": "string",
        "msisdn": "string",
        "imsi": "string",
        "imei": "string",
        "ranType": "_LTE_3G_2G_AUTO",
        "testNodeId": 0,
        "testNodeName": "string",
        "testNodeInternalName": "string",
        "deviceModelId": 0,
        "deviceModelName": "string",
        "subscriptionType": "string",
        "platformName": "string",
        "deviceId": "string",
        "nationalFormat": "string",
        "internationalFormat": "string",
        "iccid": "string",
        "eid": "string",
        "projects": [
            {
                "id": 0,
                "name": "string"
            }
        ]
    }
],
"totalElements": 0,
"totalPages": 0,
"number": 0,
"size": 20
}
404

Resource was not found.

Delete a Test Node

/api/v2/testnodes/{id} 📋 Copied! ▼

Role: Admin.

Parameters

Name Description
id * Numeric ID of the Test Node.
Type: integer (path)

Responses

Code Description
200

Test Node was deleted successfully.
404

Resource was not found.
409

Mobile Devices are still assigned to this node. Move or delete them first.

Get the uptime of all Test Nodes

/api/v2/testnodes/uptime 📋 Copied! ▼

Role: Guest and above.

Responses

Code Description
200

One entry per Test Node. status is UP, DOWN or UNKNOWN; time is a human-readable duration, for example 1 day 3 minutes.

Media type: application/json

Example Value:

{
"data": [
    {
        "id": 0,
        "name": "string",
        "status": "UP",
        "time": "1 day 3 minutes"
    }
]
}