Skip to content

Mc2IdManager.StatusApi

All URIs are relative to http://127.0.0.1:46841/api

Method HTTP request Description
getEndpoints GET /v1/endpoints Get all endpoints
getVersion GET /v1/version Get version information
ping GET /v1/ping Ping service

getEndpoints

StatusGetEndpointsResponse getEndpoints()

Get all endpoints

Get all possible endpoints types.

Example

var Mc2IdManager = require('mc2_id_manager');

var apiInstance = new Mc2IdManager.StatusApi();

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

Parameters

This endpoint does not need any parameter.

Return type

StatusGetEndpointsResponse

Authorization

No authorization required

HTTP request headers

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

getVersion

StatusGetVersionResponse getVersion()

Get version information

Get version information from application.

Example

var Mc2IdManager = require('mc2_id_manager');

var apiInstance = new Mc2IdManager.StatusApi();

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

Parameters

This endpoint does not need any parameter.

Return type

StatusGetVersionResponse

Authorization

No authorization required

HTTP request headers

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

ping

ModelEmpty ping()

Ping service

Ping the service to check if it's alive.

Example

var Mc2IdManager = require('mc2_id_manager');

var apiInstance = new Mc2IdManager.StatusApi();

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

Parameters

This endpoint does not need any parameter.

Return type

ModelEmpty

Authorization

No authorization required

HTTP request headers

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