• Home
• org.symphonyoss.symphony
• symphony-agent-java-jersey2-client
• 1.0.1
• source code
• SystemApi.md

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

docs.SystemApi.md Maven / Gradle / Ivy

# SystemApi

All URIs are relative to *https://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**v1HealthCheckGet**](SystemApi.md#v1HealthCheckGet) | **GET** /v1/HealthCheck | Checks the health of the Agent.



# **v1HealthCheckGet**
> V1HealthCheckResponse v1HealthCheckGet()

Checks the health of the Agent.

Used to validate the configuration of the agent. Makes a request to the HealthCheck on the Symphony cloud. Makes a request to the HealthCheck on the Key Manager service. 

### Example
```java
// Import classes:
//import org.symphonyoss.symphony.agent.invoker.ApiException;
//import org.symphonyoss.symphony.agent.api.SystemApi;


SystemApi apiInstance = new SystemApi();
try {
    V1HealthCheckResponse result = apiInstance.v1HealthCheckGet();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SystemApi#v1HealthCheckGet");
    e.printStackTrace();
}
```

### Parameters
This endpoint does not need any parameter.

### Return type

[**V1HealthCheckResponse**](V1HealthCheckResponse.md)

### Authorization

No authorization required

### HTTP request headers

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