Skip to main content
PATCH
/
global_ip_assignments
/
{id}
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

const globalIPAssignment = await client.globalIPAssignments.update('6a09cdc3-8948-47f0-aa62-74ac943d6c58', {
  body: {},
});

console.log(globalIPAssignment.data);
{
  "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",
    "is_connected": true,
    "is_in_maintenance": true,
    "is_announced": true
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

Identifies the resource.

Example:

"6a09cdc3-8948-47f0-aa62-74ac943d6c58"

Body

application/json
global_ip_id
string<uuid>

Global IP ID.

Example:

"a836125b-20b6-452e-9c03-2653f09c7ed7"

wireguard_peer_id
string<uuid>

Wireguard peer ID.

Example:

"e66c496d-4a85-423b-8b2a-8e63fac20320"

is_in_maintenance
boolean

Enable/disable BGP announcement.

Response

Successful response

data
Global IP · object