Skip to content

DefaultApi.md

Latest commit

 

History

History
392 lines (295 loc) · 10.4 KB

DefaultApi.md

File metadata and controls

392 lines (295 loc) · 10.4 KB

DefaultApi

All URIs are relative to https://push.databox.com

Method HTTP request Description
dataDelete DELETE /data
dataMetricKeyDelete DELETE /data/{metricKey}
dataPost POST /data
metrickeysGet GET /metrickeys
metrickeysPost POST /metrickeys
pingGet GET /ping

dataDelete

dataDelete()

Example

// Import classes:
import org.databox.ApiClient;
import org.databox.ApiException;
import org.databox.Configuration;
import org.databox.auth.*;
import org.databox.models.*;
import org.databox.api.DefaultApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://push.databox.com");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    DefaultApi apiInstance = new DefaultApi(defaultClient);
    try {
      apiInstance.dataDelete();
    } catch (ApiException e) {
      System.err.println("Exception when calling DefaultApi#dataDelete");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 OK -

dataMetricKeyDelete

dataMetricKeyDelete(metricKey)

Example

// Import classes:
import org.databox.ApiClient;
import org.databox.ApiException;
import org.databox.Configuration;
import org.databox.auth.*;
import org.databox.models.*;
import org.databox.api.DefaultApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://push.databox.com");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    DefaultApi apiInstance = new DefaultApi(defaultClient);
    String metricKey = "metricKey_example"; // String | 
    try {
      apiInstance.dataMetricKeyDelete(metricKey);
    } catch (ApiException e) {
      System.err.println("Exception when calling DefaultApi#dataMetricKeyDelete");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
metricKey String

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 OK -

dataPost

dataPost(pushData)

Example

// Import classes:
import org.databox.ApiClient;
import org.databox.ApiException;
import org.databox.Configuration;
import org.databox.auth.*;
import org.databox.models.*;
import org.databox.api.DefaultApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://push.databox.com");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    DefaultApi apiInstance = new DefaultApi(defaultClient);
    List<PushData> pushData = Arrays.asList(); // List<PushData> | 
    try {
      apiInstance.dataPost(pushData);
    } catch (ApiException e) {
      System.err.println("Exception when calling DefaultApi#dataPost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
pushData List<PushData> [optional]

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json, application/vnd.databox.v2+json
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 OK -

metrickeysGet

metrickeysGet()

Example

// Import classes:
import org.databox.ApiClient;
import org.databox.ApiException;
import org.databox.Configuration;
import org.databox.auth.*;
import org.databox.models.*;
import org.databox.api.DefaultApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://push.databox.com");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    DefaultApi apiInstance = new DefaultApi(defaultClient);
    try {
      apiInstance.metrickeysGet();
    } catch (ApiException e) {
      System.err.println("Exception when calling DefaultApi#metrickeysGet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 OK -

metrickeysPost

metrickeysPost(body)

Example

// Import classes:
import org.databox.ApiClient;
import org.databox.ApiException;
import org.databox.Configuration;
import org.databox.auth.*;
import org.databox.models.*;
import org.databox.api.DefaultApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://push.databox.com");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    DefaultApi apiInstance = new DefaultApi(defaultClient);
    Object body = null; // Object | 
    try {
      apiInstance.metrickeysPost(body);
    } catch (ApiException e) {
      System.err.println("Exception when calling DefaultApi#metrickeysPost");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name Type Description Notes
body Object [optional]

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: application/json, application/vnd.databox.v2+json
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 OK -

pingGet

pingGet()

Example

// Import classes:
import org.databox.ApiClient;
import org.databox.ApiException;
import org.databox.Configuration;
import org.databox.auth.*;
import org.databox.models.*;
import org.databox.api.DefaultApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://push.databox.com");
    
    // Configure HTTP basic authorization: basicAuth
    HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
    basicAuth.setUsername("YOUR USERNAME");
    basicAuth.setPassword("YOUR PASSWORD");

    DefaultApi apiInstance = new DefaultApi(defaultClient);
    try {
      apiInstance.pingGet();
    } catch (ApiException e) {
      System.err.println("Exception when calling DefaultApi#pingGet");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

This endpoint does not need any parameter.

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status code Description Response headers
200 OK -