Sign in
Global IPs

Create a Global IP

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 body

created_atstring

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

idstring uuid

Identifies the resource.

record_typestring

Identifies the type of the resource.

updated_atstring

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

descriptionstring

A user specified description for the address.

ip_addressstring

The Global IP address.

namestring

A user specified name for the address.

portsobject

A Global IP ports grouped by protocol code.

Example request

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

Response

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

Example response

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

Changes

Changed in 2 of the 61 revisions of this API.4

  • 1571b0380bd72See the full diff
    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status 422

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from integer/int32 to string/ for status default

      response-property-type-changed

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e5379942See the full diff
    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status 422

      response-property-type-changed

    • ▲

      the errors/items/code response's property type/format changed from string/ to integer/int32 for status default

      response-property-type-changed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog