Global IP Assignment Usage Metrics

GET 
/global_ip_assignments_usage

Global IP Assignment Usage Metrics

Query Parameters

filter[global_ip_assignment_id][in] string

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

filter[global_ip_id][in] string

Filter by Global IP 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

200: Successful response

application/json

• Schema
• Example (from schema)

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.

transmitted

object

amount number

The amount of data transmitted.

unit string

The unit of the amount of data transmitted.

received

object

amount number

The amount of data received.

unit string

The unit of the amount of data received.

]

{
  "data": [
    {
      "timestamp": "2020-01-01T00:00:00.000Z",
      "global_ip": {
        "id": "a836125b-20b6-452e-9c03-2653f09c7ed7",
        "ip_address": "64.1.4.130"
      },
      "global_ip_assignment": {
        "id": "a836125b-20b6-452e-9c03-2653f09c7ed7",
        "wireguard_peer_id": "e66c496d-4a85-423b-8b2a-8e63fac20320",
        "wireguard_peer": {
          "name": "Wireguard Peer 1",
          "ip_address": "172.1.0.1"
        }
      },
      "transmitted": {
        "amount": 100000,
        "unit": "B"
      },
      "received": {
        "amount": 100000,
        "unit": "B"
      }
    }
  ]
}

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_assignments_usage' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• default

---

{
  "data": [
    {
      "timestamp": "2020-01-01T00:00:00.000Z",
      "global_ip": {
        "id": "a836125b-20b6-452e-9c03-2653f09c7ed7",
        "ip_address": "64.1.4.130"
      },
      "global_ip_assignment": {
        "id": "a836125b-20b6-452e-9c03-2653f09c7ed7",
        "wireguard_peer_id": "e66c496d-4a85-423b-8b2a-8e63fac20320",
        "wireguard_peer": {
          "name": "Wireguard Peer 1",
          "ip_address": "172.1.0.1"
        }
      },
      "transmitted": {
        "amount": 100000,
        "unit": "B"
      },
      "received": {
        "amount": 100000,
        "unit": "B"
      }
    }
  ]
}

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