Skip to navigation
API ReferenceInternet Exchange (IX)

Update IX

View as Markdown

Updates editable information for an IX.

The productUid identifies the IX.

Tip: Use the /v2/product endpoint to determine the productUid.

The changes are defined in the Body of the request. Only include the attributes that you want to update.

Note: You can update a product only when its provisioning status is CONFIGURED or LIVE.

For more details, see Changing an IX Configuration with the API.

Available Attributes

These attributes can be updated using this endpoint:

AttributeDescription
name(String) Name of the IX
rateLimit(Integer) Rate limit in Mbps
costCentre(String) For invoicing purposes
vlan(Integer)
macAddress(String)
asn(Integer) Be very careful about changing this
password(String) BGP password
publicGraph(Boolean)
reverseDns(String) DNS lookup of a domain name from an IP address. You can change this value to enter a custom hostname for your IP address.
aEndProductUid(String) Move the IX by changing the A-End of the IX. Provide the productUid of the new A-End.
shutdown(Boolean) Shut down and re-enable the IX. Valid values are true (shut down) and false (enabled). If not provided, it defaults to false (enabled).

Move IX

You can move an IX by updating the A-End using the aEndProductUid field.

There are rules that determine where and how you can move an IX:

  • The new A-End Port can be in a different location but must be in the same metro area.

  • The IX must at least be in a Configured state.

  • An IX locked by a Company Admin can’t be moved.

  • You can move an unlocked IX under a locked Port.

  • The source and destination Ports must be owned by the same customer account.

  • Any user who is allowed to edit the speed of an IX can move the IX from any account type.

  • The move must not cause a change to billing.

If the IX move is invalid, the move will fail.

Path parameters

productUidstringRequired

Request

This endpoint expects an object.
rateLimitdoubleOptional

Response

Update IX - Rate Limit / Update IX - Reverse DNS / Move IX / Shut Down IX / Re-enable IX / Move IX / Update IX - Reverse DNS / Shut Down IX / Re-enable IX / Update IX - Rate Limit

dataobjectOptional
messagestringOptional
termsstringOptional