Updated on 2024-11-11 GMT+08:00

Deleting a Health Check

Function

This API is used to delete a health check.

Calling Method

For details, see Calling APIs.

URI

DELETE /v1/health-checks/{health_check_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

health_check_id

Yes

String

Specifies the health check ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Specifies the user token. The token can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token.

Response Parameters

None

Example Requests

Deleting a health check

DELETE https://{ga_endpoint}/v1/health-checks/c2b210b2-60c4-449d-91e2-9e9ea1dd7442

Example Responses

None

Status Codes

Status Code

Description

204

Health check deleted.

Error Codes

See Error Codes.