---
title: Get Endpoint Health Check
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/go)

[Diagnostics](https://developers.cloudflare.com/api/go/resources/diagnostics)

[Endpoint Healthchecks](https://developers.cloudflare.com/api/go/resources/diagnostics/subresources/endpoint-healthchecks)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Get Endpoint Health Check

client.Diagnostics.EndpointHealthchecks.Get(ctx, id, query) (\*[EndpointHealthcheckGetResponse](<https://developers.cloudflare.com/api/go/resources/diagnostics#(resource)%20diagnostics.endpoint-healthchecks%20%3E%20(model)%20EndpointHealthcheckGetResponse%20%3E%20(schema)>), error)

GET/accounts/{account\_id}/diagnostics/endpoint-healthchecks/{id}

Get a single Endpoint Health Check.

##### Security

<details>

<summary>API Token</summary>



The preferred authorization scheme for interacting with the Cloudflare API. <a href="https://developers.cloudflare.com/fundamentals/api/get-started/create-token/">Create a token</a>.

**Example:**<code>Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY</code>

</details>

<details>

<summary>API Email + API Key</summary>



The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

**Example:**<code>X-Auth-Email: user@example.com</code>

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

**Example:**<code>X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194</code>

</details>

##### Accepted Permissions (at least one required)

`Magic Transit Write`

##### ParametersExpand Collapse

id string

UUID.

maxLength36

[Link to this property](<#(resource)%20diagnostics.endpoint-healthchecks%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20id%20%3E%20(schema)>)

<details>

<summary>

query EndpointHealthcheckGetParams

</summary>

AccountID param.Field\[string]

Identifier

maxLength32

<a href="#(resource)%20diagnostics.endpoint-healthchecks%20%3E%20(method)%20get%20%3E%20(params)%20default%20%3E%20(param)%20account_id">Link to this property</a>

</details>

[Link to this property](<#(resource)%20diagnostics.endpoint-healthchecks%20%3E%20(method)%20get%20%3E%20(params)%20default>)

##### ReturnsExpand Collapse

<details>

<summary>

type EndpointHealthcheckGetResponse struct{…}

</summary>

CheckType EndpointHealthcheckGetResponseCheckType

type of check to perform

<a href="#(resource)%20diagnostics.endpoint-healthchecks%20%3E%20(model)%20EndpointHealthcheckGetResponse%20%3E%20(schema)%20%3E%20(property)%20check_type">Link to this property</a>

Endpoint string

the IP address of the host to perform checks against

<a href="#(resource)%20diagnostics.endpoint-healthchecks%20%3E%20(model)%20EndpointHealthcheckGetResponse%20%3E%20(schema)%20%3E%20(property)%20endpoint">Link to this property</a>

ID stringOptional

UUID.

maxLength36

<a href="#(resource)%20diagnostics.endpoint-healthchecks%20%3E%20(model)%20EndpointHealthcheckGetResponse%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

Name stringOptional

Optional name associated with this check

<a href="#(resource)%20diagnostics.endpoint-healthchecks%20%3E%20(model)%20EndpointHealthcheckGetResponse%20%3E%20(schema)%20%3E%20(property)%20name">Link to this property</a>

</details>

[Link to this property](<#(resource)%20diagnostics.endpoint-healthchecks%20%3E%20(model)%20EndpointHealthcheckGetResponse%20%3E%20(schema)>)

### Get Endpoint Health Check

Go

HTTPTypeScriptPythonGoTerraform

```
package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/diagnostics"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  endpointHealthcheck, err := client.Diagnostics.EndpointHealthchecks.Get(
    context.TODO(),
    "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    diagnostics.EndpointHealthcheckGetParams{
      AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", endpointHealthcheck.ID)
}
```

200 example

```
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "check_type": "icmp",
    "endpoint": "203.0.113.1",
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "name": "My Endpoint"
  }
}
```

##### Returns Examples

200 example

```
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "check_type": "icmp",
    "endpoint": "203.0.113.1",
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "name": "My Endpoint"
  }
}
```