diagnostic_tests.save
- Nathaniel Halbrooks
- Kelli Higdon
Owned by Nathaniel Halbrooks
Versioning Notes
This method and the functionality it provides was added in v. 1.1.
Description
Run a collection of diagnostic tests.
Arguments
name | value type | default value |
|---|---|---|
patloop_test | object | members detailed below |
patloop_test.run | boolean | whether or not to run this test |
patloop_test.ports | array of integers or strings | list of port numbers to test |
Example Requests & Responses
Example One
Request
Run the patloop test, which is the only test available as of version 1.1.
{
    'method' => 'diagnostic_tests.save',
    'parameters' => {
          'patloop_test' => {
                                 'run' => '1',
                                 'ports' => [
                                                '1',
                                                '2'
                                            ],
                            },
        } |
Response
{
          'result' => {
                        'patloop_test' => {
                                             '1' => {
                                                        'result' => 'failure', # or success
                                                        'error' => 'error string'
                                                    },
                                             '2' => {
                                                        'result' => 'failure', # or success
                                                        'error' => 'error string'
                                                    },
                                          },
                      },
 } |