mirror of
https://github.com/GlueOps/autoglue.git
synced 2026-02-13 04:40:05 +01:00
71 lines
1.6 KiB
Markdown
71 lines
1.6 KiB
Markdown
# \HealthAPI
|
|
|
|
All URIs are relative to */api/v1*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**HealthCheckOperationId**](HealthAPI.md#HealthCheckOperationId) | **Get** /healthz | Basic health check
|
|
|
|
|
|
|
|
## HealthCheckOperationId
|
|
|
|
> HandlersHealthStatus HealthCheckOperationId(ctx).Execute()
|
|
|
|
Basic health check
|
|
|
|
|
|
|
|
### Example
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"os"
|
|
openapiclient "github.com/glueops/autoglue-sdk-go"
|
|
)
|
|
|
|
func main() {
|
|
|
|
configuration := openapiclient.NewConfiguration()
|
|
apiClient := openapiclient.NewAPIClient(configuration)
|
|
resp, r, err := apiClient.HealthAPI.HealthCheckOperationId(context.Background()).Execute()
|
|
if err != nil {
|
|
fmt.Fprintf(os.Stderr, "Error when calling `HealthAPI.HealthCheckOperationId``: %v\n", err)
|
|
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
|
|
}
|
|
// response from `HealthCheckOperationId`: HandlersHealthStatus
|
|
fmt.Fprintf(os.Stdout, "Response from `HealthAPI.HealthCheckOperationId`: %v\n", resp)
|
|
}
|
|
```
|
|
|
|
### Path Parameters
|
|
|
|
This endpoint does not need any parameter.
|
|
|
|
### Other Parameters
|
|
|
|
Other parameters are passed through a pointer to a apiHealthCheckOperationIdRequest struct via the builder pattern
|
|
|
|
|
|
### Return type
|
|
|
|
[**HandlersHealthStatus**](HandlersHealthStatus.md)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: Not defined
|
|
- **Accept**: application/json
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints)
|
|
[[Back to Model list]](../README.md#documentation-for-models)
|
|
[[Back to README]](../README.md)
|
|
|