​

ves-io-schema-healthcheck-API-Create

Published April 5, 2023 | Last modified September 8, 2026

Examples of creating healthcheck

Usecase:

Create healthcheck-productpage to check health of productpage in bookinfo application

Request using vesctl:

vesctl configuration create healthcheck -i healthcheck.yaml

where file healthcheck.yaml has following contents (healthcheck.CreateRequest):

RequestJSON:

{
    "metadata": {
        "name": "healthcheck-productpage",
        "namespace": "documentation"
    },
    "spec": {
        "http_health_check": {
            "host_header": "productpage.internal.bookinfo.com",
            "path": "/healthcheck"
        },
        "timeout": 3,
        "interval": 10,
        "unhealthy_threshold": 3,
        "healthy_threshold": 2,
        "jitter_percent": 20
    }
}

vesctl yaml response:

ResponseJSON:

{
    "metadata": {
        "name": "healthcheck-productpage",
        "namespace": "documentation",
        "labels": {},
        "annotations": {},
        "description": "",
        "disable": false
    },
    "system_metadata": {
        "uid": "87c9c578-505b-481f-88a0-36effa8c27a4",
        "creation_timestamp": "2026-06-19T22:03:08.452111Z",
        "deletion_timestamp": null,
        "modification_timestamp": null,
        "initializers": null,
        "finalizers": [],
        "tenant": "acmecorp",
        "creator_class": "examplesvc",
        "creator_id": "examplesvc",
        "object_index": 0,
        "owner_view": null,
        "labels": {}
    },
    "spec": {
        "http_health_check": {
            "host_header": "productpage.internal.bookinfo.com",
            "path": "/healthcheck",
            "headers": {},
            "request_headers_to_remove": [],
            "use_http2": false,
            "expected_status_codes": [],
            "expected_response": ""
        },
        "timeout": 3,
        "interval": 10,
        "jitter": 0,
        "unhealthy_threshold": 3,
        "healthy_threshold": 2,
        "jitter_percent": 20
    }
}

Request using curl:

curl -X 'POST' -d '{"metadata":{"name":"healthcheck-productpage","namespace":"documentation"},"spec":{"http_health_check":{"host_header":"productpage.internal.bookinfo.com","path":"/healthcheck"},"timeout":3,"interval":10,"unhealthy_threshold":3,"healthy_threshold":2,"jitter_percent":20}}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build1655461974_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/documentation/healthchecks'

curl response:

HTTP/1.1 200 OK
Content-Length: 1059
Content-Type: application/json
Date: Fri, 19 Jun 2026 22:03:08 GMT
Vary: Accept-Encoding


{
  "metadata": {
    "name": "healthcheck-productpage",
    "namespace": "documentation",
    "labels": {
    },
    "annotations": {
    },
    "description": "",
    "disable": false
  },
  "system_metadata": {
    "uid": "87c9c578-505b-481f-88a0-36effa8c27a4",
    "creation_timestamp": "2026-06-19T22:03:08.452111Z",
    "deletion_timestamp": null,
    "modification_timestamp": null,
    "initializers": null,
    "finalizers": [
    ],
    "tenant": "acmecorp",
    "creator_class": "examplesvc",
    "creator_id": "examplesvc",
    "object_index": 0,
    "owner_view": null,
    "labels": {
    }
  },
  "spec": {
    "http_health_check": {
      "host_header": "productpage.internal.bookinfo.com",
      "path": "/healthcheck",
      "headers": {
      },
      "request_headers_to_remove": [
      ],
      "use_http2": false,
      "expected_status_codes": [
      ],
      "expected_response": ""
    },
    "timeout": 3,
    "interval": 10,
    "jitter": 0,
    "unhealthy_threshold": 3,
    "healthy_threshold": 2,
    "jitter_percent": 20
  }
}
On this page: