Skip to content

Latest commit

 

History

History
200 lines (140 loc) · 4.84 KB

HeartbeatApi.md

File metadata and controls

200 lines (140 loc) · 4.84 KB

HeartbeatApi

All URIs are relative to https://api.flipdish.co

Method HTTP request Description
headHostname HEAD /api/v1.0/heartbeat/Hostname
headPing HEAD /api/v1.0/heartbeat
hostname GET /api/v1.0/heartbeat/Hostname
ping GET /api/v1.0/heartbeat

headHostname

Object headHostname()

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.HeartbeatApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

HeartbeatApi apiInstance = new HeartbeatApi();
try {
    Object result = apiInstance.headHostname();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling HeartbeatApi#headHostname");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

Object

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

headPing

RestApiStringResult headPing()

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.HeartbeatApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

HeartbeatApi apiInstance = new HeartbeatApi();
try {
    RestApiStringResult result = apiInstance.headPing();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling HeartbeatApi#headPing");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

RestApiStringResult

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

hostname

Object hostname()

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.HeartbeatApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

HeartbeatApi apiInstance = new HeartbeatApi();
try {
    Object result = apiInstance.hostname();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling HeartbeatApi#hostname");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

Object

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml

ping

RestApiStringResult ping()

Example

// Import classes:
//import com.flipdish.apiclient.ApiClient;
//import com.flipdish.apiclient.ApiException;
//import com.flipdish.apiclient.Configuration;
//import com.flipdish.apiclient.auth.*;
//import com.flipdish.apiclient.api.HeartbeatApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure OAuth2 access token for authorization: oauth2
OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
oauth2.setAccessToken("YOUR ACCESS TOKEN");

HeartbeatApi apiInstance = new HeartbeatApi();
try {
    RestApiStringResult result = apiInstance.ping();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling HeartbeatApi#ping");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

RestApiStringResult

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, text/json, application/xml, text/xml