Difference between revisions of "NATS5 REST API Maintenance GET nats"
From TMM Wiki
Jump to navigationJump to search| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_maintenance_section = true |
}} | }} | ||
== '''GET /maintenance/nats''' == | == '''GET /maintenance/nats''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Get NATS status | * Get NATS 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 20: | Line 21: | ||
None | None | ||
| + | == '''Example Request''' == | ||
| + | Method: '''GET'''<br/> | ||
| + | URL: <nowiki>http://domain/api/maintenance/nats</nowiki><br/> | ||
| + | |||
| + | Response: | ||
| + | <pre> | ||
| + | { | ||
| + | "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" | ||
| + | } | ||
| + | ] | ||
| + | } | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | |||
== '''Example Code''' == | == '''Example Code''' == | ||
| Line 33: | Line 97: | ||
$url = 'http://yourdomain.com'; //set your NATS URL here | $url = 'http://yourdomain.com'; //set your NATS URL here | ||
| − | $data = array( | + | $data = array(); |
| − | |||
| − | ); | ||
$request = Array( | $request = Array( | ||
| Line 76: | Line 138: | ||
</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 --> | ||
Latest revision as of 15:59, 9 August 2019
GET /maintenance/nats
Description
- Get NATS status
Resource URL
- http://domain/api/maintenance/nats
- Replace domain with the nats domain
- GET
Response Format
- JSON
- HTTP headers
Parameters
None
Example Request
Method: GET
URL: http://domain/api/maintenance/nats
Response:
{
"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"
}
]
}
}
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();
$request = Array(
'method' => 'GET',
'path' => 'v1/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);
?>
