Virtual Cross Connects

Update the Virtual Cross Connect

Update the Virtual Cross Connect.<br /><br />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.<br /><br />Once the Virtual Cross Connect has moved to provisioned and you are ready to enable routing, you can toggle the routing announcements to true.

patch/virtual_cross_connects/{id}

Path parameters

idstring uuid required
Example:6a09cdc3-8948-47f0-aa62-74ac943d6c58

Identifies the resource.

Request body

primary_enabledboolean

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

primary_routing_announcementboolean

Whether the primary BGP route is being announced.

primary_cloud_ipstring

The IP address assigned for your side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value can not be patched once the VXC has bene provisioned.

secondary_enabledboolean

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

secondary_routing_announcementboolean

Whether the secondary BGP route is being announced.

secondary_cloud_ipstring

The IP address assigned for your side of the Virtual Cross Connect.<br /><br />If none is provided, one will be generated for you.<br /><br />This value can not be patched once the VXC has bene provisioned.

Example request

{
  "primary_enabled": true,
  "primary_cloud_ip": "169.254.0.2",
  "secondary_enabled": true,
  "secondary_cloud_ip": "169.254.0.4"
}

Response

Successful response

Example response

{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "sample_record_type",
    "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_telnyx_ip": "169.254.0.3",
    "secondary_cloud_ip": "169.254.0.4",
    "secondary_bgp_key": "ge1lONeK9RcA83uuWaw9DvZy",
    "region_code": "ashburn-va",
    "region": {
      "code": "ashburn-va",
      "name": "Ashburn",
      "record_type": "region"
    }
  }
}

Changes

Changed in 4 of the 47 revisions of this API.43842

  • 8a8c40f458c51191See the full diff
    • the data response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • removed the optional property data/bandwidth_mbps from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/bgp_asn from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/cloud_provider from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/cloud_provider_region from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/created_at from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/id from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/name from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/network_id from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/primary_bgp_key from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/primary_cloud_account_id from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/primary_cloud_ip from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/primary_enabled from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/primary_routing_announcement from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/primary_telnyx_ip from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/record_type from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/region from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/region_code from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/status from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/updated_at from the response with the 200 status

      response-optional-property-removed

    • added VirtualCrossConnectCreate VirtualCrossConnectPatch RegionOut to the data response property allOf list for the response status 200

      response-property-all-of-added

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

  • 50870cc05614120See the full diff
    • the data response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • added the optional property data/bandwidth_mbps to the response with the 200 status

      response-optional-property-added

    • added the optional property data/bgp_asn to the response with the 200 status

      response-optional-property-added

    • added the optional property data/cloud_provider to the response with the 200 status

      response-optional-property-added

    • added the optional property data/cloud_provider_region to the response with the 200 status

      response-optional-property-added

    • added the optional property data/created_at to the response with the 200 status

      response-optional-property-added

    • added the optional property data/id to the response with the 200 status

      response-optional-property-added

    • added the optional property data/name to the response with the 200 status

      response-optional-property-added

    • added the optional property data/network_id to the response with the 200 status

      response-optional-property-added

    • added the optional property data/primary_bgp_key to the response with the 200 status

      response-optional-property-added

    • added the optional property data/primary_cloud_account_id to the response with the 200 status

      response-optional-property-added

    • added the optional property data/primary_cloud_ip to the response with the 200 status

      response-optional-property-added

    • added the optional property data/primary_enabled to the response with the 200 status

      response-optional-property-added

    • added the optional property data/primary_routing_announcement to the response with the 200 status

      response-optional-property-added

    • added the optional property data/primary_telnyx_ip to the response with the 200 status

      response-optional-property-added

    • added the optional property data/record_type to the response with the 200 status

      response-optional-property-added

    • added the optional property data/region to the response with the 200 status

      response-optional-property-added

    • added the optional property data/region_code to the response with the 200 status

      response-optional-property-added

    • added the optional property data/status to the response with the 200 status

      response-optional-property-added

    • added the optional property data/updated_at to the response with the 200 status

      response-optional-property-added

    • removed VirtualCrossConnectCreate VirtualCrossConnectPatch RegionOut from the data response property allOf list for the response status 200

      response-property-all-of-removed

  • a144ff96b4ac1191See the full diff
    • the data response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • removed the optional property data/bandwidth_mbps from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/bgp_asn from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/cloud_provider from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/cloud_provider_region from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/created_at from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/id from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/name from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/network_id from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/primary_bgp_key from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/primary_cloud_account_id from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/primary_cloud_ip from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/primary_enabled from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/primary_routing_announcement from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/primary_telnyx_ip from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/record_type from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/region from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/region_code from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/status from the response with the 200 status

      response-optional-property-removed

    • removed the optional property data/updated_at from the response with the 200 status

      response-optional-property-removed

    • added VirtualCrossConnectCreate VirtualCrossConnectPatch RegionOut to the data response property allOf list for the response status 200

      response-property-all-of-added

  • 30cb1ddce91b120See the full diff
    • the data response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • added the optional property data/bandwidth_mbps to the response with the 200 status

      response-optional-property-added

    • added the optional property data/bgp_asn to the response with the 200 status

      response-optional-property-added

    • added the optional property data/cloud_provider to the response with the 200 status

      response-optional-property-added

    • added the optional property data/cloud_provider_region to the response with the 200 status

      response-optional-property-added

    • added the optional property data/created_at to the response with the 200 status

      response-optional-property-added

    • added the optional property data/id to the response with the 200 status

      response-optional-property-added

    • added the optional property data/name to the response with the 200 status

      response-optional-property-added

    • added the optional property data/network_id to the response with the 200 status

      response-optional-property-added

    • added the optional property data/primary_bgp_key to the response with the 200 status

      response-optional-property-added

    • added the optional property data/primary_cloud_account_id to the response with the 200 status

      response-optional-property-added

    • added the optional property data/primary_cloud_ip to the response with the 200 status

      response-optional-property-added

    • added the optional property data/primary_enabled to the response with the 200 status

      response-optional-property-added

    • added the optional property data/primary_routing_announcement to the response with the 200 status

      response-optional-property-added

    • added the optional property data/primary_telnyx_ip to the response with the 200 status

      response-optional-property-added

    • added the optional property data/record_type to the response with the 200 status

      response-optional-property-added

    • added the optional property data/region to the response with the 200 status

      response-optional-property-added

    • added the optional property data/region_code to the response with the 200 status

      response-optional-property-added

    • added the optional property data/status to the response with the 200 status

      response-optional-property-added

    • added the optional property data/updated_at to the response with the 200 status

      response-optional-property-added

    • removed VirtualCrossConnectCreate VirtualCrossConnectPatch RegionOut from the data response property allOf list for the response status 200

      response-property-all-of-removed

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