Skip to main content

GetGlobalIpAssignmentHealth

GET 

/global_ip_assignment_health

GetGlobalIpAssignmentHealth

Request

Query Parameters

    filter[global_ip_id][in] string

    Filter by Global IP ID(s) separated by commas

    filter[global_ip_assignment_id][in] string

    Filter by Global IP Assignment ID(s) separated by commas

    filter[timestamp][gt] date-time

    Filter by timestamp greater than

    filter[timestamp][lt] date-time

    Filter by timestamp less than

Responses

200: Successful response

Schema

    data

    object[]

  • Array [

  • timestamp date-time

    The timestamp of the metric.

    global_ip

    object

    id uuid

    Global IP ID.

    ip_address string

    The Global IP address.

    global_ip_assignment

    object

    id uuid

    Global IP assignment ID.

    wireguard_peer_id uuid

    Wireguard peer ID.

    wireguard_peer

    object

    name string

    A user specified name for the interface.

    ip_address string

    The IP address of the interface.

    health

    object

    pass number

    The number of successful health checks.

    fail number

    The number of failed health checks.

  • ]

default: Unexpected error

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
  • ]

Loading...