Create Load Balancer Health Monitor

Creates a Load Balancer Pool Health Monitor.

Request

URI

POST

https://{api_host}/cloudapi/1.0.0/loadBalancer/healthMonitors

COPY

Request Body

EdgeLoadBalancerHealthMonitor of type(s) application/json

Optional

Show optional properties

{
    "type": "string"
}

{
    "id": "string",
    "name": "string",
    "description": "string",
    "type": "string",
    "systemDefined": false,
    "successfulChecksCount": 0,
    "failedChecksCount": 0,
    "sendInterval": 0,
    "receiveTimeout": 0,
    "httpSettings": {
        "port": 0,
        "requestHeader": "string",
        "requestBody": "string",
        "useExactRequest": false,
        "expectedResponseData": "string",
        "expectedResponseCodes": [
            "string"
        ],
        "authSettings": {
            "type": "string",
            "username": "string",
            "password": "string"
        }
    },
    "httpsSettings": {
        "port": 0,
        "requestHeader": "string",
        "requestBody": "string",
        "useExactRequest": false,
        "expectedResponseData": "string",
        "expectedResponseCodes": [
            "string"
        ],
        "authSettings": {
            "type": "string",
            "username": "string",
            "password": "string"
        }
    },
    "tcpSettings": {
        "port": 0,
        "requestData": "string",
        "expectedResponseData": "string"
    },
    "udpSettings": {
        "port": 0,
        "requestData": "string",
        "expectedResponseData": "string"
    },
    "gatewayRef": {
        "name": "string",
        "id": "string"
    }
}

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

202

The request have been accepted and the task to monitor the request is in the Location header.

Operation doesn't return any data structure

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"type:"string"}' https://{api_host}/cloudapi/1.0.0/loadBalancer/healthMonitors

Availability

Added in 39.0

On This Page

Description

Request

Request Body

Authentication

Response

202 Response Body

Edge Gateway Load Balancer Health Monitors Operations

GET

Get Health Monitor Summaries For Gateway