Skip to main content

Update the Virtual Cross Connect

PATCH 
/virtual_cross_connects/:id

Update the Virtual Cross Connect.

Cloud IPs can only be patched during the created state, as GCE will only inform you of your generated IP once the pending connection requested has been accepted. Once the Virtual Cross Connect has moved to provisioning, the IPs can no longer be patched.

Once the Virtual Cross Connect has moved to provisioned and you are ready to enable routing, you can toggle the routing announcements to true.

Request

Path Parameters

    id uuidrequired

    Identifies the resource.

Body

required

    primary_enabled boolean

    Indicates whether the primary circuit is enabled. Setting this to false will disable the circuit.

    primary_routing_announcement boolean

    Whether the primary BGP route is being announced.

    primary_cloud_ip ipv4

    The IP address assigned for your side of the Virtual Cross Connect.

    If none is provided, one will be generated for you.

    This value can not be patched once the VXC has bene provisioned.

    secondary_enabled boolean

    Indicates whether the secondary circuit is enabled. Setting this to false will disable the circuit.

    secondary_routing_announcement boolean

    Whether the secondary BGP route is being announced.

    secondary_cloud_ip ipv4

    The IP address assigned for your side of the Virtual Cross Connect.

    If none is provided, one will be generated for you.

    This value can not be patched once the VXC has bene provisioned.

Responses

200: Successful response

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

default: Unexpected error

Request samples


curl -L -X PATCH 'https://api.telnyx.com/v2/virtual_cross_connects/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
"primary_enabled": true,
"primary_routing_announcement": false,
"primary_cloud_ip": "169.254.0.2",
"secondary_enabled": true,
"secondary_routing_announcement": false,
"secondary_cloud_ip": "169.254.0.4"
}'

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",
"network_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
"name": "test interface",
"status": "provisioned",
"cloud_provider": "aws",
"cloud_provider_region": "us-east-1",
"bgp_asn": 1234,
"bandwidth_mbps": 50,
"primary_enabled": true,
"primary_cloud_account_id": "123456789012",
"primary_telnyx_ip": "169.254.0.1",
"primary_cloud_ip": "169.254.0.2",
"primary_bgp_key": "yFV4wEPtPVPfDUGLWiyQzwga",
"secondary_enabled": true,
"secondary_cloud_account_id": "",
"secondary_telnyx_ip": "169.254.0.3",
"secondary_cloud_ip": "169.254.0.4",
"secondary_bgp_key": "ge1lONeK9RcA83uuWaw9DvZy",
"region_code": "ashburn-va",
"primary_routing_announcement": false,
"secondary_routing_announcement": false,
"region": {
"code": "ashburn-va",
"name": "Ashburn",
"record_type": "region"
}
}
}