Global IPs

Create a Global IP

Changed on

Requests creation of a new Global IP, a static IP address announced from the Telnyx network. Provisioning is asynchronous, so the request is accepted and the Global IP becomes available once provisioning completes.

post/global_ips

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/global_ips
  • 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.

ip_addressstring

The Global IP address.

portsobject

A Global IP ports grouped by protocol code.

namestring

A user specified name for the address.

descriptionstring

A user specified description for the address.

Example request

{
  "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  "record_type": "global_ip",
  "created_at": "2018-02-02T22:25:27.521Z",
  "updated_at": "2018-02-02T22:25:27.521Z",
  "ip_address": "198.51.100.1",
  "ports": {
    "tcp": [
      80,
      8080
    ],
    "udp": [
      5000,
      5050
    ]
  },
  "name": "test interface",
  "description": "test interface"
}

Response

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

Example response

{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "global_ip",
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z",
    "ip_address": "198.51.100.1",
    "ports": {
      "tcp": [
        80,
        8080
      ],
      "udp": [
        5000,
        5050
      ]
    },
    "name": "test interface",
    "description": "test interface"
  }
}

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