List all Global IP Health check types

GET 
/global_ip_health_check_types

List all Global IP Health check types.

Responses

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data object[]

{
  "data": [
    {
      "record_type": "global_ip_health_check_type",
      "health_check_type": "http_status_2xx",
      "health_check_params": {
        "health_check_params": {
          "path": "str",
          "port": "int"
        }
      }
    }
  ]
}

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code intrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta object

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/global_ip_health_check_types' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• default

---

{
  "data": [
    {
      "record_type": "global_ip_health_check_type",
      "health_check_type": "http_status_2xx",
      "health_check_params": {
        "health_check_params": {
          "path": "str",
          "port": "int"
        }
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}