Global IPs

Create a Global IP assignment

Changed on

Assigns a Global IP to a WireGuard peer so traffic destined for the IP is delivered over that peer's tunnel. Assignment is asynchronous, so the request is accepted and completes in the background.

post/global_ip_assignments

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/global_ip_assignments
  • Auth: HTTP bearer

Request body

idstring uuid

Identifies the resource.

record_typestring

Identifies the type of the resource.

created_atstring

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

updated_atstring

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

global_ip_idstring uuid

Global IP ID.

wireguard_peer_idstring uuid

Wireguard peer ID.

status'created' | 'provisioning' | 'provisioned' | 'deleting'

The current status of the interface deployment.

is_connectedboolean

Wireguard peer is connected.

is_in_maintenanceboolean

Enable/disable BGP announcement.

is_announcedboolean

Status of BGP announcement.

Example request

{
  "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  "record_type": "global_ip_assignment",
  "created_at": "2018-02-02T22:25:27.521Z",
  "updated_at": "2018-02-02T22:25:27.521Z",
  "global_ip_id": "a836125b-20b6-452e-9c03-2653f09c7ed7",
  "wireguard_peer_id": "e66c496d-4a85-423b-8b2a-8e63fac20320",
  "status": "provisioned"
}

Response

Assignment request accepted. Provisioning is asynchronous; poll GET /global_ip_assignments/{id} with the returned id to check status.

Example response

{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "global_ip_assignment",
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z",
    "global_ip_id": "a836125b-20b6-452e-9c03-2653f09c7ed7",
    "wireguard_peer_id": "e66c496d-4a85-423b-8b2a-8e63fac20320",
    "status": "provisioned"
  }
}

Changes

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • a6a61a29ecddRevision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status