Difference between revisions of "NATS5 REST API Maintenance GET server"
From TMM Wiki
Jump to navigationJump to search| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_maintenance_section = true |
}} | }} | ||
== '''GET /maintenance/server''' == | == '''GET /maintenance/server''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get server status | * Get server status | ||
| Line 9: | Line 10: | ||
*Replace domain with the nats domain | *Replace domain with the nats domain | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']] |
*GET | *GET | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| Line 22: | Line 23: | ||
* '''limited''' | * '''limited''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
| Line 28: | Line 29: | ||
Method: '''GET'''<br/> | Method: '''GET'''<br/> | ||
URL: <nowiki>http://domain/api/maintenance/server</nowiki><br/> | URL: <nowiki>http://domain/api/maintenance/server</nowiki><br/> | ||
| + | Query String: <nowiki>limited=1</nowiki><br/> | ||
Response: | Response: | ||
| Line 35: | Line 37: | ||
"status": { | "status": { | ||
"php_version": "7.2.17-1+ubuntu14.04.1+deb.sury.org+3", | "php_version": "7.2.17-1+ubuntu14.04.1+deb.sury.org+3", | ||
| − | "php_time": | + | "php_time": 1565382560, |
| − | "php_datetime": "2019- | + | "php_datetime": "2019-08-09 16:29:20", |
"php_timezone": "America\/New_York", | "php_timezone": "America\/New_York", | ||
"mysql_version": "5.5.62-0ubuntu0.14.04.1", | "mysql_version": "5.5.62-0ubuntu0.14.04.1", | ||
| − | "mysql_time": "2019- | + | "mysql_time": "2019-08-09 16:29:20", |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
"server_software": null, | "server_software": null, | ||
"server_ip": null, | "server_ip": null, | ||
"server_name": null, | "server_name": null, | ||
| − | "server_time": "Fri | + | "server_time": "Fri Aug 9 16:29:20 EDT 2019", |
| − | "server_timezone": "America\/New_York (EDT, -0400)" | + | "server_timezone": "America\/New_York (EDT, -0400)" |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
} | } | ||
} | } | ||
| Line 129: | Line 66: | ||
$url = 'http://yourdomain.com'; //set your NATS URL here | $url = 'http://yourdomain.com'; //set your NATS URL here | ||
| − | $data = | + | $data = Array( |
| − | + | 'limited' => 1, | |
); | ); | ||
| Line 172: | Line 109: | ||
</pre> | </pre> | ||
| − | [[Category: | + | [[Category:NATS5_REST_APIs]] |
| − | [[Category: | + | [[Category:NATS5_REST_maintenance_Collection]] |
[[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | [[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | ||
[[Category:Autogenerated_Rest_Sample]]<!-- This article has a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> | [[Category:Autogenerated_Rest_Sample]]<!-- This article has a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> | ||
Latest revision as of 15:59, 9 August 2019
GET /maintenance/server
Description
- Get server status
Resource URL
- http://domain/api/maintenance/server
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- limited
- type: boolean_digit (0 or 1)
- optional
Example Request
Method: GET
URL: http://domain/api/maintenance/server
Query String: limited=1
Response:
{
"success": true,
"status": {
"php_version": "7.2.17-1+ubuntu14.04.1+deb.sury.org+3",
"php_time": 1565382560,
"php_datetime": "2019-08-09 16:29:20",
"php_timezone": "America\/New_York",
"mysql_version": "5.5.62-0ubuntu0.14.04.1",
"mysql_time": "2019-08-09 16:29:20",
"server_software": null,
"server_ip": null,
"server_name": null,
"server_time": "Fri Aug 9 16:29:20 EDT 2019",
"server_timezone": "America\/New_York (EDT, -0400)"
}
}
Example Code
PHP
<?php
$headers = array( //set your username and API key here
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: tmm1phrvezsbu'
);
$url = 'http://yourdomain.com'; //set your NATS URL here
$data = Array(
'limited' => 1,
);
$request = Array(
'method' => 'GET',
'path' => 'v1/maintenance/server',
'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);
?>
