# SwiftShiftApi.HealthCheckApi

All URIs are relative to *http://localhost:3000*

Method | HTTP request | Description
------------- | ------------- | -------------
[**deleteHealthCheck**](HealthCheckApi.md#deleteHealthCheck) | **DELETE** /health_checks/{id} | Deletes health check by id
[**listHealthChecks**](HealthCheckApi.md#listHealthChecks) | **GET** /health_checks | Gets list of all health checks
[**postHealthCheck**](HealthCheckApi.md#postHealthCheck) | **POST** /health_checks | Creates a health check
[**putHealthCheck**](HealthCheckApi.md#putHealthCheck) | **PUT** /health_checks/{id} | Updates health check by id


<a name="deleteHealthCheck"></a>
# **deleteHealthCheck**
> HealthCheck deleteHealthCheck(id)

Deletes health check by id

delete healthCheck

### Example
```javascript
import SwiftShiftApi from 'swift_shift_api';

let apiInstance = new SwiftShiftApi.HealthCheckApi();
let id = "id_example"; // String | id of healthCheck
apiInstance.deleteHealthCheck(id, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**| id of healthCheck | 

### Return type

[**HealthCheck**](HealthCheck.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="listHealthChecks"></a>
# **listHealthChecks**
> InlineResponse20018 listHealthChecks(opts)

Gets list of all health checks

### Example
```javascript
import SwiftShiftApi from 'swift_shift_api';

let apiInstance = new SwiftShiftApi.HealthCheckApi();
let opts = {
  'take': 50, // Number | Page size.
  'skip': 0, // Number | The start index.
  'search': "search_example", // String | Search phrase.
  'select': ["null"], // [String] | List of the properties to return.
  'sort': ["null"], // [String] | List of the properties to sort by.
  'q': "q_example" // String | resource query language
};
apiInstance.listHealthChecks(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **take** | **Number**| Page size. | [optional] [default to 50]
 **skip** | **Number**| The start index. | [optional] [default to 0]
 **search** | **String**| Search phrase. | [optional] 
 **select** | [**[String]**](String.md)| List of the properties to return. | [optional] 
 **sort** | [**[String]**](String.md)| List of the properties to sort by. | [optional] 
 **q** | **String**| resource query language | [optional] 

### Return type

[**InlineResponse20018**](InlineResponse20018.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="postHealthCheck"></a>
# **postHealthCheck**
> HealthCheck postHealthCheck(opts)

Creates a health check

### Example
```javascript
import SwiftShiftApi from 'swift_shift_api';

let apiInstance = new SwiftShiftApi.HealthCheckApi();
let opts = {
  'healthCheck': new SwiftShiftApi.HealthCheck() // HealthCheck | 
};
apiInstance.postHealthCheck(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **healthCheck** | [**HealthCheck**](HealthCheck.md)|  | [optional] 

### Return type

[**HealthCheck**](HealthCheck.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="putHealthCheck"></a>
# **putHealthCheck**
> HealthCheck putHealthCheck(id, opts)

Updates health check by id

### Example
```javascript
import SwiftShiftApi from 'swift_shift_api';

let apiInstance = new SwiftShiftApi.HealthCheckApi();
let id = "id_example"; // String | id of healthCheck
let opts = {
  'healthCheck': new SwiftShiftApi.HealthCheck() // HealthCheck | 
};
apiInstance.putHealthCheck(id, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**| id of healthCheck | 
 **healthCheck** | [**HealthCheck**](HealthCheck.md)|  | [optional] 

### Return type

[**HealthCheck**](HealthCheck.md)

### Authorization

No authorization required

### HTTP request headers

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