Skip to main content

Create a Global IP assignment

POST 
/global_ip_assignments

Create a Global IP assignment.

Request

Body

required

    global_ip_id uuid

    Global IP ID.

    wireguard_peer_id uuid

    Wireguard peer ID.

    is_in_maintenance boolean

    Enable/disable BGP announcement.

Responses

202: Successful response

422: Unprocessable entity. Check the 'detail' field in response for details.

default: Unexpected error

Request samples


curl -L 'https://api.telnyx.com/v2/global_ip_assignments' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
"global_ip_id": "a836125b-20b6-452e-9c03-2653f09c7ed7",
"wireguard_peer_id": "e66c496d-4a85-423b-8b2a-8e63fac20320",
"is_in_maintenance": true
}'

Response samples


{
"data": {
"id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"record_type": true,
"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
}
}