# RedbrickChallenge.ServiceApi

All URIs are relative to _http://localhost:8083/{version}_

| Method                                 | HTTP request      | Description |
| -------------------------------------- | ----------------- | ----------- |
| [**liveness**](ServiceApi.md#liveness) | **GET** /liveness |
| [**ready**](ServiceApi.md#ready)       | **GET** /ready    |

<a name="liveness"></a>

# **liveness**

> liveness()

Liveness

### Example

```javascript
import {RedbrickChallenge} from 'redbrick_challenge';

let apiInstance = new RedbrickChallenge.ServiceApi();
apiInstance.liveness((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

This endpoint does not need any parameter.

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

<a name="ready"></a>

# **ready**

> ready()

Readiness

### Example

```javascript
import {RedbrickChallenge} from 'redbrick_challenge';

let apiInstance = new RedbrickChallenge.ServiceApi();
apiInstance.ready((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

This endpoint does not need any parameter.

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined