portainer_api/docs/StatusApi.md

PortainerApi.StatusApi

All URIs are relative to http://portainer.domain/api

Method	HTTP request	Description
statusInspect	GET /status	Check Portainer status

statusInspect

Status statusInspect()

Check Portainer status

Retrieve Portainer status. Access policy: public

Example

var PortainerApi = require('portainer_api');
var defaultClient = PortainerApi.ApiClient.instance;

// Configure API key authorization: jwt
var jwt = defaultClient.authentications['jwt'];
jwt.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//jwt.apiKeyPrefix = 'Token';

var apiInstance = new PortainerApi.StatusApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.statusInspect(callback);

Parameters

This endpoint does not need any parameter.

Return type

Status

Authorization

jwt

HTTP request headers

• Content-Type: Not defined
• Accept: application/json