Skip to content

HealthApi.md

Latest commit

 

History

History
72 lines (54 loc) · 2.04 KB

HealthApi.md

File metadata and controls

72 lines (54 loc) · 2.04 KB

HealthApi

All URIs are relative to https://api.builtbybit.com

Method HTTP request Description
getV2Health GET /v2/health Retrieve a health status

getV2Health

GetV2Health200Response getV2Health()

Retrieve a health status

Example

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.HealthApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.builtbybit.com");
    
    // Configure API key authorization: token
    ApiKeyAuth token = (ApiKeyAuth) defaultClient.getAuthentication("token");
    token.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //token.setApiKeyPrefix("Token");

    HealthApi apiInstance = new HealthApi(defaultClient);
    try {
      GetV2Health200Response result = apiInstance.getV2Health();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling HealthApi#getV2Health");
      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

GetV2Health200Response

Authorization

token

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -