Healthchecks
GET HealthChecks#
Gets all healthchecks associated with the current distribution
| GET ALL | |
|---|---|
| Method | GET ALL |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId}/healthchecks |
| Headers | Authorization |
| Parameters | distributionId, projectId, version |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string($uuid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| {distributionId} | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| projectId | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty project configuration is returned |
| distributionId | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
| Version | Yes | string($uuid) | v1 | Shows the version of API |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": [ { "id": 0, "distributionId": "string", "name": "string", "requestMethod": "string", "requestPath": "string", "host": "string", "expectedResponse": 0, "interval": 0 } ], "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | array [] | "string" | Indicate if there was an error |
| messages | array [] | "string" | Returns the response message from back-end |
| result | array [object] | Returns a behavior object | |
| id | integer($int32) | 0 | The identifier for the healthe check |
| distributionId | "string" | string | Returns the distribution id |
| name | string | "string" | Returns name of the healthcheck |
| requestMethod | string | "string" | Returns the request method |
| requestPath | string | "string" | Returns the request path |
| host | string | "string" | Returns the host for the healthcheck |
| expectedResponse | integer($int32) | 0 | Returns the expected response for the healthcheck |
| interval | integer($int32) | 0 | Returns the interval for the healthcheck |
| resultInfo | array [object] | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
POST Healthcheck#
Creates a new healthcheck.
| POST | |
|---|---|
| Method | POST |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId}/healthchecks |
| Headers | Authorization |
| Parameters | projectId, distributionId, version |
| Body | { name, requestMethod, requestPath, host, expectedResponse. threshold, window, interval, timeout, initial } |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string($uuid) | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| {distributionId} | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| projectId | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty project configuration is returned |
| distributionId | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
| Version | Yes | string($uuid) | v1 | Shows the version of API |
Request body#
{ "name": "string", "requestMethod": 0, "requestPath": "string", "host": "string", "expectedResponse": 0, "threshold": 0, "window": 0, "interval": 0, "timeout": 0, "initial": 0}
The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| name | Yes | string | "string" | Sends the name for healthcheck |
| requestMethod | Yes | integer($int32) | 0 | Sends the request method |
| requestPath | Yes | string | "string" | Sends the request path |
| host | No | string | "string" | Sends the host |
| expectedResponse | Yes | integer($int32) | 0 | Sends the expected response |
| threshold | Yes | integer($int32) | 0 | Sends the threshold |
| window | Yes | integer($int32) | 0 | Sends the window |
| interval | Yes | integer($int32) | 0 | Sends the interval for the healthcheck |
| timeout | No | integer($int32) | 0 | Sends the timeout for healthcheck |
| initial | Yes | integer($int32) | 0 | Sends the initial for the healthcheck |
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "id": 0, "distributionId": "string", "name": "string", "requestMethod": 0, "requestPath": "string", "host": "string", "expectedResponse": 0, "threshold": 0, "window": 0, "interval": 0, "timeout": 0, "initial": 0, "requestMethodOptions": [ { "id": 0, "value": "string" } ], "expectedResponseOptions": [ { "id": 0, "value": "string" } ] }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | string | "string" | Indicate if there was an error |
| messages | string | "string" | Returns the response message from back-end |
| result | array [object] | Returns a behavior object | |
| id | integer($int32) | 0 | The identifier for the behavior |
| distributionId | string | "string" | Returns the identifier of distribution in behaviors |
| name | string | "string" | Returns the name for healthcheck |
| requestMethod | integer($int32) | 0 | Returns the request method |
| requestPath | string | "string" | Returns the request path |
| host | string | "string" | Returns the host |
| expectedResponse | integer($int32) | 0 | Returns the expected response |
| threshold | integer($int32) | 0 | Returns the threshold |
| window | integer($int32) | 0 | Returns the window |
| interval | integer($int32) | 0 | Returns the interval for the healthcheck |
| timeout | integer($int32) | 0 | Returns the timeout for healthcheck |
| initial | integer($int32) | 0 | Returns the initial for the healthcheck |
| requestMethodOptions | array[object] | Returns the request method options | |
| id | string | "string" | Returns the id of request method option |
| value | string | "string" | Returns the value of the request method option |
| expectedResponseOptions | array[object] | Returns the expected response options | |
| id | integer($int32) | 0 | Returns the id of expected response options |
| value | integer($int32) | 0 | Returns the value of expected response options |
| resultInfo | array [object] | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
GET HealthCheck#
Gets the healthcheck by id
| GET | |
|---|---|
| Method | GET By Id |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId}/healthchecks/{id} |
| Headers | Authorization |
| Parameters | distributionId, id, version, projectId |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| {distributionId} | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
| {id} | Yes | integer($int32) | 0 | Shows the version of API |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| projectId | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| version | Yes | string | v1 | Shows the version of API |
| distributionId | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
| id | Yes | integer($int32) | 0 | The behavior's ID. |
Request Body#
The request does not have a request body.
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "id": 0, "distributionId": "string", "name": "string", "requestMethod": 0, "requestPath": "string", "host": "string", "expectedResponse": 0, "threshold": 0, "window": 0, "interval": 0, "timeout": 0, "initial": 0, "requestMethodOptions": [ { "id": 0, "value": "string" } ], "expectedResponseOptions": [ { "id": 0, "value": "string" } ] }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | string | "string" | Indicate if there was an error |
| messages | string | "string" | Returns the response message from back-end |
| result | array [object] | Returns a behavior object | |
| id | integer($int32) | 0 | The identifier for the behavior |
| distributionId | string | "string" | Returns the identifier of distribution in behaviors |
| name | string | "string" | Returns the name for healthcheck |
| requestMethod | integer($int32) | 0 | Returns the request method |
| requestPath | string | "string" | Returns the request path |
| host | string | "string" | Returns the host |
| expectedResponse | integer($int32) | 0 | Returns the expected response |
| threshold | integer($int32) | 0 | Returns the threshold |
| window | integer($int32) | 0 | Returns the window |
| interval | integer($int32) | 0 | Returns the interval for the healthcheck |
| timeout | integer($int32) | 0 | Returns the timeout for healthcheck |
| initial | integer($int32) | 0 | Returns the initial for the healthcheck |
| requestMethodOptions | array[object] | Returns the request method options | |
| id | string | "string" | Returns the id of request method option |
| value | string | "string" | Returns the value of the request method option |
| expectedResponseOptions | array[object] | Returns the expected response options | |
| id | integer($int32) | 0 | Returns the id of expected response options |
| value | integer($int32) | 0 | Returns the value of expected response options |
| resultInfo | array [object] | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
PUT HealthCheck#
Updates an existing healthcheck.
| PUT | |
|---|---|
| Method | PUT |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId}/healthchecks/{id} |
| Headers | Authorization |
| Parameters | distributionId, id, version, projectId |
| Body | { name, requestMethod, requestPath, host, expectedResponse. threshold, window, interval, timeout, initial |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| {distributionId} | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
| {id} | Yes | integer($int32) | 0 | Shows the version of API |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| projectId | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| version | Yes | string | v1 | Shows the version of API |
| distributionId | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
| id | Yes | integer($int32) | 0 | The behavior's ID. |
Request body#
{ "name": "string", "requestMethod": 0, "requestPath": "string", "host": "string", "expectedResponse": 0, "threshold": 0, "window": 0, "interval": 0, "timeout": 0, "initial": 0}
The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| name | Yes | string | "string" | Sends the name for healthcheck |
| requestMethod | Yes | integer($int32) | 0 | Sends the request method |
| requestPath | Yes | string | "string" | Sends the request path |
| host | No | string | "string" | Sends the host |
| expectedResponse | Yes | integer($int32) | 0 | Sends the expected response |
| threshold | Yes | integer($int32) | 0 | Sends the threshold |
| window | Yes | integer($int32) | 0 | Sends the window |
| interval | Yes | integer($int32) | 0 | Sends the interval for the healthcheck |
| timeout | No | integer($int32) | 0 | Sends the timeout for healthcheck |
| initial | Yes | integer($int32) | 0 | Sends the initial for the healthcheck |
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "id": 0, "distributionId": "string", "name": "string", "requestMethod": 0, "requestPath": "string", "host": "string", "expectedResponse": 0, "threshold": 0, "window": 0, "interval": 0, "timeout": 0, "initial": 0, "requestMethodOptions": [ { "id": 0, "value": "string" } ], "expectedResponseOptions": [ { "id": 0, "value": "string" } ] }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | string | "string" | Indicate if there was an error |
| messages | string | "string" | Returns the response message from back-end |
| result | array [object] | Returns a behavior object | |
| id | integer($int32) | 0 | The identifier for the behavior |
| distributionId | string | "string" | Returns the identifier of distribution in behaviors |
| name | string | "string" | Returns the name for healthcheck |
| requestMethod | integer($int32) | 0 | Returns the request method |
| requestPath | string | "string" | Returns the request path |
| host | string | "string" | Returns the host |
| expectedResponse | integer($int32) | 0 | Returns the expected response |
| threshold | integer($int32) | 0 | Returns the threshold |
| window | integer($int32) | 0 | Returns the window |
| interval | integer($int32) | 0 | Returns the interval for the healthcheck |
| timeout | integer($int32) | 0 | Returns the timeout for healthcheck |
| initial | integer($int32) | 0 | Returns the initial for the healthcheck |
| requestMethodOptions | array[object] | Returns the request method options | |
| id | string | "string" | Returns the id of request method option |
| value | string | "string" | Returns the value of the request method option |
| expectedResponseOptions | array[object] | Returns the expected response options | |
| id | integer($int32) | 0 | Returns the id of expected response options |
| value | integer($int32) | 0 | Returns the value of expected response options |
| resultInfo | array [object] | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found
DELETE HealthCheck#
Deletes healthcheck by id.
| DELETE | |
|---|---|
| Method | DELETE |
| URL or EndPoint | /api/v{version}/projects/{projectId}/distributions/{distributionId}/behaviors/{id} |
| Headers | Authorization |
| Parameters | distributionId, id, version, projectId |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| v{version} | Yes | string | v1 | Shows the version of API |
| {projectId} | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| {distributionId} | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
| {id} | Yes | integer($int32) | 0 | Shows the version of API |
The description of the parameters is as follows:
| Parameter Name | Mandatory | Type | Example | Description |
|---|---|---|---|---|
| projectId | Yes | string | 3fa85f64-5717-4562-b3fc-2c963f66afa6 | The project's ID. If the ID is empty, an empty distribution configuration is returned |
| version | Yes | string | v1 | Shows the version of API |
| distributionId | Yes | string | "string" | The distribution's ID. If the ID is empty, an empty distribution configuration is returned |
| id | Yes | integer($int32) | 0 | The behavior's ID. |
Responses#
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in json format by the service.
{ "success": true, "errors": [ "string" ], "messages": [ "string" ], "result": { "id": 0, "distributionId": "string", "name": "string", "requestMethod": 0, "requestPath": "string", "host": "string", "expectedResponse": 0, "threshold": 0, "window": 0, "interval": 0, "timeout": 0, "initial": 0, "requestMethodOptions": [ { "id": 0, "value": "string" } ], "expectedResponseOptions": [ { "id": 0, "value": "string" } ] }, "resultInfo": { "totalCount": 0, "pageIndex": 0, "pageSize": 0, "totalPages": 0, "hasNextPage": true, "hasPreviousPage": true }}| Field Name | Type | Example | Description |
|---|---|---|---|
| success | bool | true | If response is success will return true otherwise will return false |
| errors | string | "string" | Indicate if there was an error |
| messages | string | "string" | Returns the response message from back-end |
| result | array [object] | Returns a behavior object | |
| id | integer($int32) | 0 | The identifier for the behavior |
| distributionId | string | "string" | Returns the identifier of distribution in behaviors |
| name | string | "string" | Returns the name for healthcheck |
| requestMethod | integer($int32) | 0 | Returns the request method |
| requestPath | string | "string" | Returns the request path |
| host | string | "string" | Returns the host |
| expectedResponse | integer($int32) | 0 | Returns the expected response |
| threshold | integer($int32) | 0 | Returns the threshold |
| window | integer($int32) | 0 | Returns the window |
| interval | integer($int32) | 0 | Returns the interval for the healthcheck |
| timeout | integer($int32) | 0 | Returns the timeout for healthcheck |
| initial | integer($int32) | 0 | Returns the initial for the healthcheck |
| requestMethodOptions | array[object] | Returns the request method options | |
| id | string | "string" | Returns the id of request method option |
| value | string | "string" | Returns the value of the request method option |
| expectedResponseOptions | array[object] | Returns the expected response options | |
| id | integer($int32) | 0 | Returns the id of expected response options |
| value | integer($int32) | 0 | Returns the value of expected response options |
| resultInfo | array [object] | Returns an object of behavior | |
| totalCount | integer($int32) | 0 | How many records of behavior entity are in database |
| pageIndex | integer($int32) | 0 | Returns how many pages of paganed data are |
| pageSize | integer($int32) | 0 | Returns paganed data |
| totalPages | integer($int32) | 0 | How many pages |
| hasNextPage | bool | true | Returns the next page of paganed data |
| hasPreviousPage | bool | true | Returns the previous page of paganed data |
Errors
For information about the errors that are common to all actions, see Common Errors:
- HTTP Status Code: 401 Unauthorized
- HTTP Status Code: 403 Forbidden
- HTTP Status Code: 404 Not found