Difference between revisions of "NATS5 REST API Maintenance GET server"
From TMM Wiki
Jump to navigationJump to search| Line 25: | Line 25: | ||
** optional | ** optional | ||
| + | == '''Example Request''' == | ||
| + | Method: '''GET'''<br/> | ||
| + | URL: <nowiki>http://domain/api/maintenance/server</nowiki><br/> | ||
| + | |||
| + | Response: | ||
| + | <pre> | ||
| + | { | ||
| + | "success": true, | ||
| + | "status": { | ||
| + | "php_version": "7.2.17-1+ubuntu14.04.1+deb.sury.org+3", | ||
| + | "php_time": 1559929898, | ||
| + | "php_datetime": "2019-06-07 13:51:38", | ||
| + | "php_timezone": "America\/New_York", | ||
| + | "mysql_version": "5.5.62-0ubuntu0.14.04.1", | ||
| + | "mysql_time": "2019-06-07 13:51:38", | ||
| + | "mysql_table_problems": [], | ||
| + | "php_modules": [ | ||
| + | "Core", | ||
| + | "date", | ||
| + | "libxml", | ||
| + | "openssl", | ||
| + | "pcre", | ||
| + | "zlib", | ||
| + | "filter", | ||
| + | "hash", | ||
| + | "pcntl", | ||
| + | "Reflection", | ||
| + | "SPL", | ||
| + | "sodium", | ||
| + | "session", | ||
| + | "standard", | ||
| + | "mysqlnd", | ||
| + | "PDO", | ||
| + | "xml", | ||
| + | "calendar", | ||
| + | "ctype", | ||
| + | "curl", | ||
| + | "dom", | ||
| + | "mbstring", | ||
| + | "fileinfo", | ||
| + | "ftp", | ||
| + | "gd", | ||
| + | "gettext", | ||
| + | "iconv", | ||
| + | "json", | ||
| + | "exif", | ||
| + | "mysqli", | ||
| + | "pdo_mysql", | ||
| + | "Phar", | ||
| + | "posix", | ||
| + | "readline", | ||
| + | "shmop", | ||
| + | "SimpleXML", | ||
| + | "sockets", | ||
| + | "sysvmsg", | ||
| + | "sysvsem", | ||
| + | "sysvshm", | ||
| + | "tokenizer", | ||
| + | "wddx", | ||
| + | "xmlreader", | ||
| + | "xmlwriter", | ||
| + | "xsl", | ||
| + | "zip", | ||
| + | "ionCube Loader", | ||
| + | "Zend OPcache" | ||
| + | ], | ||
| + | "stats_server": false, | ||
| + | "server_software": null, | ||
| + | "server_ip": null, | ||
| + | "server_name": null, | ||
| + | "server_time": "Fri Jun 7 13:51:38 EDT 2019", | ||
| + | "server_timezone": "America\/New_York (EDT, -0400)", | ||
| + | "php_settings": { | ||
| + | "disable_functions": [], | ||
| + | "display_errors": "1", | ||
| + | "error_reporting": "6135", | ||
| + | "error_reporting_nice": "E_ALL except: E_USER_DEPRECATED, E_DEPRECATED, E_STRICT, E_NOTICE", | ||
| + | "max_execution_time": "0", | ||
| + | "max_input_time": "-1", | ||
| + | "memory_limit": "1024M", | ||
| + | "post_max_size": "8M", | ||
| + | "register_globals": 0, | ||
| + | "safe_mode": 0, | ||
| + | "upload_max_filesize": "2M" | ||
| + | } | ||
| + | } | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | |||
== '''Example Code''' == | == '''Example Code''' == | ||
| Line 84: | Line 175: | ||
[[Category:NATS4_REST_maintenance_Collection]] | [[Category:NATS4_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 --> | ||
Revision as of 13:27, 7 June 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
- optional
Example Request
Method: GET
URL: http://domain/api/maintenance/server
Response:
{
"success": true,
"status": {
"php_version": "7.2.17-1+ubuntu14.04.1+deb.sury.org+3",
"php_time": 1559929898,
"php_datetime": "2019-06-07 13:51:38",
"php_timezone": "America\/New_York",
"mysql_version": "5.5.62-0ubuntu0.14.04.1",
"mysql_time": "2019-06-07 13:51:38",
"mysql_table_problems": [],
"php_modules": [
"Core",
"date",
"libxml",
"openssl",
"pcre",
"zlib",
"filter",
"hash",
"pcntl",
"Reflection",
"SPL",
"sodium",
"session",
"standard",
"mysqlnd",
"PDO",
"xml",
"calendar",
"ctype",
"curl",
"dom",
"mbstring",
"fileinfo",
"ftp",
"gd",
"gettext",
"iconv",
"json",
"exif",
"mysqli",
"pdo_mysql",
"Phar",
"posix",
"readline",
"shmop",
"SimpleXML",
"sockets",
"sysvmsg",
"sysvsem",
"sysvshm",
"tokenizer",
"wddx",
"xmlreader",
"xmlwriter",
"xsl",
"zip",
"ionCube Loader",
"Zend OPcache"
],
"stats_server": false,
"server_software": null,
"server_ip": null,
"server_name": null,
"server_time": "Fri Jun 7 13:51:38 EDT 2019",
"server_timezone": "America\/New_York (EDT, -0400)",
"php_settings": {
"disable_functions": [],
"display_errors": "1",
"error_reporting": "6135",
"error_reporting_nice": "E_ALL except: E_USER_DEPRECATED, E_DEPRECATED, E_STRICT, E_NOTICE",
"max_execution_time": "0",
"max_input_time": "-1",
"memory_limit": "1024M",
"post_max_size": "8M",
"register_globals": 0,
"safe_mode": 0,
"upload_max_filesize": "2M"
}
}
}
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(
// Add API parameters here
);
$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);
?>
