Basic ping for monitoring or a health-check.
Conduit conduit.ping
conduit.ping
conduit.ping
API Method: conduit.ping
API Method: conduit.ping
- Returns
- string
- Errors
- ERR-CONDUIT-CORE: See error message for details.
- OAuth Scope
- OAuth clients may never call this method.
Method Description
Method Description
Call Method
Call Method
Examples
Examples
- Use the Conduit API Tokens panel in Settings to generate or manage API tokens.
- If you submit parameters, these examples will update to show exactly how to encode the parameters you submit.
$ echo <json-parameters> | arc call-conduit --conduit-uri https://vyos.dev/ --conduit-token <conduit-token> -- conduit.ping
$ curl https://vyos.dev/api/conduit.ping \
-d api.token=api-token \
-d param=value \
...
-d api.token=api-token \
-d param=value \
...
<?php
require_once 'path/to/arcanist/support/init/init-script.php';
$api_token = "<api-token>";
$api_parameters = array(<parameters>);
$client = new ConduitClient('https://vyos.dev/');
$client->setConduitToken($api_token);
$result = $client->callMethodSynchronous('conduit.ping', $api_parameters);
print_r($result);