docs/HealthcheckApi.md in fastly-4.0.0.alpha4 vs docs/HealthcheckApi.md in fastly-4.0.0

- old
+ new

@@ -8,48 +8,49 @@ ## Methods | Method | HTTP request | Description | | ------ | ------------ | ----------- | -| [**create_healthcheck**](HealthcheckApi.md#create_healthcheck) | **POST** /service/{service_id}/version/{version_id}/healthcheck | Create a healthcheck | -| [**delete_healthcheck**](HealthcheckApi.md#delete_healthcheck) | **DELETE** /service/{service_id}/version/{version_id}/healthcheck/{healthcheck_name} | Delete a healthcheck | -| [**get_healthcheck**](HealthcheckApi.md#get_healthcheck) | **GET** /service/{service_id}/version/{version_id}/healthcheck/{healthcheck_name} | Get a healthcheck | -| [**list_healthchecks**](HealthcheckApi.md#list_healthchecks) | **GET** /service/{service_id}/version/{version_id}/healthcheck | List healthchecks | -| [**update_healthcheck**](HealthcheckApi.md#update_healthcheck) | **PUT** /service/{service_id}/version/{version_id}/healthcheck/{healthcheck_name} | Update a healthcheck | +| [**create_healthcheck**](HealthcheckApi.md#create_healthcheck) | **POST** /service/{service_id}/version/{version_id}/healthcheck | Create a health check | +| [**delete_healthcheck**](HealthcheckApi.md#delete_healthcheck) | **DELETE** /service/{service_id}/version/{version_id}/healthcheck/{healthcheck_name} | Delete a health check | +| [**get_healthcheck**](HealthcheckApi.md#get_healthcheck) | **GET** /service/{service_id}/version/{version_id}/healthcheck/{healthcheck_name} | Get a health check | +| [**list_healthchecks**](HealthcheckApi.md#list_healthchecks) | **GET** /service/{service_id}/version/{version_id}/healthcheck | List health checks | +| [**update_healthcheck**](HealthcheckApi.md#update_healthcheck) | **PUT** /service/{service_id}/version/{version_id}/healthcheck/{healthcheck_name} | Update a health check | ## `create_healthcheck()` ```ruby -create_healthcheck(opts): <HealthcheckResponse> # Create a healthcheck +create_healthcheck(opts): <HealthcheckResponse> # Create a health check ``` -Create a healthcheck for a particular service and version. +Create a health check for a particular service and version. ### Examples ```ruby api_instance = Fastly::HealthcheckApi.new opts = { service_id: 'service_id_example', # String | Alphanumeric string identifying the service. version_id: 56, # Integer | Integer identifying a service version. - check_interval: 56, # Integer | How often to run the healthcheck in milliseconds. + check_interval: 56, # Integer | How often to run the health check in milliseconds. comment: 'comment_example', # String | A freeform descriptive note. expected_response: 56, # Integer | The status code expected from the host. + headers: ['inner_example'], # Array<String> | Array of custom headers that will be added to the health check probes. host: 'host_example', # String | Which host to check. http_version: 'http_version_example', # String | Whether to use version 1.0 or 1.1 HTTP. initial: 56, # Integer | When loading a config, the initial number of probes to be seen as OK. method: 'method_example', # String | Which HTTP method to use. - name: 'name_example', # String | The name of the healthcheck. + name: 'name_example', # String | The name of the health check. path: 'path_example', # String | The path to check. - threshold: 56, # Integer | How many healthchecks must succeed to be considered healthy. + threshold: 56, # Integer | How many health checks must succeed to be considered healthy. timeout: 56, # Integer | Timeout in milliseconds. - window: 56, # Integer | The number of most recent healthcheck queries to keep for this healthcheck. + window: 56, # Integer | The number of most recent health check queries to keep for this health check. } begin - # Create a healthcheck + # Create a health check result = api_instance.create_healthcheck(opts) p result rescue Fastly::ApiError => e puts "Error when calling HealthcheckApi->create_healthcheck: #{e}" end @@ -59,49 +60,50 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **service_id** | **String** | Alphanumeric string identifying the service. | | | **version_id** | **Integer** | Integer identifying a service version. | | -| **check_interval** | **Integer** | How often to run the healthcheck in milliseconds. | [optional] | +| **check_interval** | **Integer** | How often to run the health check in milliseconds. | [optional] | | **comment** | **String** | A freeform descriptive note. | [optional] | | **expected_response** | **Integer** | The status code expected from the host. | [optional] | +| **headers** | [**Array&lt;String&gt;**](String.md) | Array of custom headers that will be added to the health check probes. | [optional] | | **host** | **String** | Which host to check. | [optional] | | **http_version** | **String** | Whether to use version 1.0 or 1.1 HTTP. | [optional] | | **initial** | **Integer** | When loading a config, the initial number of probes to be seen as OK. | [optional] | | **method** | **String** | Which HTTP method to use. | [optional] | -| **name** | **String** | The name of the healthcheck. | [optional] | +| **name** | **String** | The name of the health check. | [optional] | | **path** | **String** | The path to check. | [optional] | -| **threshold** | **Integer** | How many healthchecks must succeed to be considered healthy. | [optional] | +| **threshold** | **Integer** | How many health checks must succeed to be considered healthy. | [optional] | | **timeout** | **Integer** | Timeout in milliseconds. | [optional] | -| **window** | **Integer** | The number of most recent healthcheck queries to keep for this healthcheck. | [optional] | +| **window** | **Integer** | The number of most recent health check queries to keep for this health check. | [optional] | ### Return type [**HealthcheckResponse**](HealthcheckResponse.md) [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) ## `delete_healthcheck()` ```ruby -delete_healthcheck(opts): <InlineResponse200> # Delete a healthcheck +delete_healthcheck(opts): <InlineResponse200> # Delete a health check ``` -Delete the healthcheck for a particular service and version. +Delete the health check for a particular service and version. ### Examples ```ruby api_instance = Fastly::HealthcheckApi.new opts = { service_id: 'service_id_example', # String | Alphanumeric string identifying the service. version_id: 56, # Integer | Integer identifying a service version. - healthcheck_name: 'healthcheck_name_example', # String | The name of the healthcheck. + healthcheck_name: 'healthcheck_name_example', # String | The name of the health check. } begin - # Delete a healthcheck + # Delete a health check result = api_instance.delete_healthcheck(opts) p result rescue Fastly::ApiError => e puts "Error when calling HealthcheckApi->delete_healthcheck: #{e}" end @@ -111,38 +113,38 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **service_id** | **String** | Alphanumeric string identifying the service. | | | **version_id** | **Integer** | Integer identifying a service version. | | -| **healthcheck_name** | **String** | The name of the healthcheck. | | +| **healthcheck_name** | **String** | The name of the health check. | | ### Return type [**InlineResponse200**](InlineResponse200.md) [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) ## `get_healthcheck()` ```ruby -get_healthcheck(opts): <HealthcheckResponse> # Get a healthcheck +get_healthcheck(opts): <HealthcheckResponse> # Get a health check ``` -Get the healthcheck for a particular service and version. +Get the health check for a particular service and version. ### Examples ```ruby api_instance = Fastly::HealthcheckApi.new opts = { service_id: 'service_id_example', # String | Alphanumeric string identifying the service. version_id: 56, # Integer | Integer identifying a service version. - healthcheck_name: 'healthcheck_name_example', # String | The name of the healthcheck. + healthcheck_name: 'healthcheck_name_example', # String | The name of the health check. } begin - # Get a healthcheck + # Get a health check result = api_instance.get_healthcheck(opts) p result rescue Fastly::ApiError => e puts "Error when calling HealthcheckApi->get_healthcheck: #{e}" end @@ -152,25 +154,25 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **service_id** | **String** | Alphanumeric string identifying the service. | | | **version_id** | **Integer** | Integer identifying a service version. | | -| **healthcheck_name** | **String** | The name of the healthcheck. | | +| **healthcheck_name** | **String** | The name of the health check. | | ### Return type [**HealthcheckResponse**](HealthcheckResponse.md) [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) ## `list_healthchecks()` ```ruby -list_healthchecks(opts): <Array<HealthcheckResponse>> # List healthchecks +list_healthchecks(opts): <Array<HealthcheckResponse>> # List health checks ``` -List all of the healthchecks for a particular service and version. +List all of the health checks for a particular service and version. ### Examples ```ruby api_instance = Fastly::HealthcheckApi.new @@ -178,11 +180,11 @@ service_id: 'service_id_example', # String | Alphanumeric string identifying the service. version_id: 56, # Integer | Integer identifying a service version. } begin - # List healthchecks + # List health checks result = api_instance.list_healthchecks(opts) p result rescue Fastly::ApiError => e puts "Error when calling HealthcheckApi->list_healthchecks: #{e}" end @@ -202,39 +204,40 @@ [[Back to top]](#) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md) ## `update_healthcheck()` ```ruby -update_healthcheck(opts): <HealthcheckResponse> # Update a healthcheck +update_healthcheck(opts): <HealthcheckResponse> # Update a health check ``` -Update the healthcheck for a particular service and version. +Update the health check for a particular service and version. ### Examples ```ruby api_instance = Fastly::HealthcheckApi.new opts = { service_id: 'service_id_example', # String | Alphanumeric string identifying the service. version_id: 56, # Integer | Integer identifying a service version. - healthcheck_name: 'healthcheck_name_example', # String | The name of the healthcheck. - check_interval: 56, # Integer | How often to run the healthcheck in milliseconds. + healthcheck_name: 'healthcheck_name_example', # String | The name of the health check. + check_interval: 56, # Integer | How often to run the health check in milliseconds. comment: 'comment_example', # String | A freeform descriptive note. expected_response: 56, # Integer | The status code expected from the host. + headers: ['inner_example'], # Array<String> | Array of custom headers that will be added to the health check probes. host: 'host_example', # String | Which host to check. http_version: 'http_version_example', # String | Whether to use version 1.0 or 1.1 HTTP. initial: 56, # Integer | When loading a config, the initial number of probes to be seen as OK. method: 'method_example', # String | Which HTTP method to use. - name: 'name_example', # String | The name of the healthcheck. + name: 'name_example', # String | The name of the health check. path: 'path_example', # String | The path to check. - threshold: 56, # Integer | How many healthchecks must succeed to be considered healthy. + threshold: 56, # Integer | How many health checks must succeed to be considered healthy. timeout: 56, # Integer | Timeout in milliseconds. - window: 56, # Integer | The number of most recent healthcheck queries to keep for this healthcheck. + window: 56, # Integer | The number of most recent health check queries to keep for this health check. } begin - # Update a healthcheck + # Update a health check result = api_instance.update_healthcheck(opts) p result rescue Fastly::ApiError => e puts "Error when calling HealthcheckApi->update_healthcheck: #{e}" end @@ -244,22 +247,23 @@ | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **service_id** | **String** | Alphanumeric string identifying the service. | | | **version_id** | **Integer** | Integer identifying a service version. | | -| **healthcheck_name** | **String** | The name of the healthcheck. | | -| **check_interval** | **Integer** | How often to run the healthcheck in milliseconds. | [optional] | +| **healthcheck_name** | **String** | The name of the health check. | | +| **check_interval** | **Integer** | How often to run the health check in milliseconds. | [optional] | | **comment** | **String** | A freeform descriptive note. | [optional] | | **expected_response** | **Integer** | The status code expected from the host. | [optional] | +| **headers** | [**Array&lt;String&gt;**](String.md) | Array of custom headers that will be added to the health check probes. | [optional] | | **host** | **String** | Which host to check. | [optional] | | **http_version** | **String** | Whether to use version 1.0 or 1.1 HTTP. | [optional] | | **initial** | **Integer** | When loading a config, the initial number of probes to be seen as OK. | [optional] | | **method** | **String** | Which HTTP method to use. | [optional] | -| **name** | **String** | The name of the healthcheck. | [optional] | +| **name** | **String** | The name of the health check. | [optional] | | **path** | **String** | The path to check. | [optional] | -| **threshold** | **Integer** | How many healthchecks must succeed to be considered healthy. | [optional] | +| **threshold** | **Integer** | How many health checks must succeed to be considered healthy. | [optional] | | **timeout** | **Integer** | Timeout in milliseconds. | [optional] | -| **window** | **Integer** | The number of most recent healthcheck queries to keep for this healthcheck. | [optional] | +| **window** | **Integer** | The number of most recent health check queries to keep for this health check. | [optional] | ### Return type [**HealthcheckResponse**](HealthcheckResponse.md)