Documentation is now available for the Fall 2020 Update release!

Status and restart NGINX service

This endpoint is used to get the NGINX service status and to restart the NGINX service on the gateway.

Leave Feedback

URL

POST https://{gatewayIp}:5480/api/v2/nginx

Sample URLs

https://192.168.xxx.xxx:5480/api/v2/nginx

Sample cURL

curl -k -X POST https://{GatewayIP}:5480/api/v2/nginx 
-H 'Accept: application/json' 
-H 'Authorization: Token <TOKEN>' 
{ 
    "action": "<restart/status>"
}

Header format

HeaderValue
AuthorizationToken {accessToken}
Content-typeapplication/json
Acceptapplication/json

Parameters

The fields are mandatory.

FieldData TypeDescription
actionStringAction item: restart or status

Status code

200 OK

Sample request

{
    "action": "status”, }

Sample response

{"Success": "Service NGINX active (Running)"}