For the complete documentation index, see llms.txt. This page is also available as Markdown.

/api/maintenance/nats

get

Get NATS status

Authorizations
api-keystringRequired
api-usernamestringRequired
Responses
200

success

successbooleanOptionalExample: true
get/api/maintenance/nats
PHP (cURL)
<?php

$headers = array( //set your username and API key here
	'api-key: 44b5498dbcb481a0d00b404c0169af62',
	'api-username: tmm1phrvezsbu'
);
$url = 'https://yourdomain.com'; //set your NATS URL here

$data = array();

$request = array(
	'method' => 'GET',
	'path' => 'maintenance/nats',
	'data' => $data
);

/*code below is the same for (almost) every API call */

$curl = curl_init();

$url = $url.'/api/'.$request['path'];

$query = http_build_query($request['data']);

if($request['method'] == 'GET'){
	//add query string parameters to the end of the url
	$url = $url.'?'.$query;
}else{
	//send parameters as POST fields
	curl_setopt($curl, CURLOPT_POST, 1);
	curl_setopt($curl, CURLOPT_POSTFIELDS, $query);

	if($request['method'] != 'POST'){
		$headers[] ='X-HTTP-Method: '.$request['method']; //send custom request method
	}
}
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);


$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>
200

success

{
  "success": true,
  "status": {
    "versions": [],
    "version_details": {
      "current": {
        "name": "5.0.1.5",
        "tested": 0,
        "released": 0,
        "old": 0,
        "current_stable": 0,
        "current_dev": 0,
        "need_update": 0,
        "date_released": 0
      },
      "stable": {
        "name": "Info Missing",
        "tested": 0,
        "released": 0,
        "old": 0,
        "current_stable": 0,
        "current_dev": 0,
        "need_update": 0,
        "date_released": 0
      },
      "dev": {
        "name": "Info Missing",
        "tested": 0,
        "released": 0,
        "old": 0,
        "current_stable": 0,
        "current_dev": 0,
        "need_update": 0,
        "date_released": 0
      },
      "library": {
        "version": "1.1.19.3"
      }
    },
    "license": {
      "expires": "Does not expire",
      "remaining": "Does not expire"
    },
    "modules": [],
    "support_links": [],
    "last_cron_run": [
      {
        "cron": "MAILER",
        "date": "1969-12-31 19:00:00"
      }
    ]
  }
}

Last updated

Was this helpful?