Delete a Global IP health check

DELETE 
/global_ip_health_checks/:id

Delete a Global IP health check.

Request

Path Parameters

id uuidrequired

Identifies the resource.

Responses

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

object

id uuid

Identifies the resource.

record_type string

Identifies the type of the resource.

created_at string

ISO 8601 formatted date-time indicating when the resource was created.

updated_at string

ISO 8601 formatted date-time indicating when the resource was updated.

health_check_type string

The Global IP health check type.

health_check_params object

A Global IP health check params.

global_ip_id uuid

Global IP ID.

{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": true,
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z",
    "health_check_type": "http_status_2xx",
    "health_check_params": {
      "path": "/",
      "port": 8080
    },
    "global_ip_id": "a836125b-20b6-452e-9c03-2653f09c7ed7"
  }
}

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 -X DELETE 'https://api.telnyx.com/v2/global_ip_health_checks/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• default

---

{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": true,
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z",
    "health_check_type": "http_status_2xx",
    "health_check_params": {
      "path": "/",
      "port": 8080
    },
    "global_ip_id": "a836125b-20b6-452e-9c03-2653f09c7ed7"
  }
}

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