Equinix Fabric API v4 | Equinix Product Documentation

Internet Exchange Services

Internet Exchange Services ^Beta

Operations

Create Internet Exchange Service

Request

This API provides capability to create Internet Exchange Service

Security

BearerAuth

Bodyapplication/jsonrequired

typestringrequired

Internet Exchange Service type

Value:"IX"

Example:"IX"

namestring, [ 1 .. 50 ] charactersrequired

Customer-provided internet exchange service name

Example:"ix_exchange_service"

descriptionstring, [ 1 .. 255 ] characters

Customer-provided internet exchange service description

Example:"ix_exchange_service"

publicPeeringConnectionobject(PublicPeeringConnectionRequest)required

Public Peering Connection

routingProtocolobject(RoutingProtocolRequest)required

orderobject(ExchangeServiceOrder)

Ordering and billing reference details for this Exchange Service.

projectobject(Project)

accountobject(SimplifiedAccount)

notificationsArray of objects(ExchangeServiceNotification)

Preferences for notifications on Internet Exchange Service configuration or status changes

Payload

{
  "type": "IX",
  "name": "ix_exchange_service",
  "publicPeeringConnection": {
    "uuid": "b44c6e6c-2c36-4488-b3f1-47064357b5b4"
  },
  "description": "ix_exchange_service",
  "routingProtocol": {
    "customerAsn": 5555,
    "macAddress": "00:11:22:33:44:55",
    "bgpIpv4": { … },
    "bgpIpv6": { … }
  },
  "order": {
    "purchaseOrderNumber": "1-3456576"
  },
  "notifications": [
    { … }
  ],
  "project": {
    "projectId": "e275485c-7072-439f-943a-c923548b2be5"
  },
  "account": {
    "accountNumber": 100179
  }
}

Responses

Successful operation

Bodyapplication/json

hrefstring

Internet Exchange Service URI

Example:"https://api.equinix.com/fabric/v4/exchangeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011"

uuidstring, (uuid)

Internet Exchange Service identifier

Example:"a8ba52de-faae-43b5-b0b1-6904d37ee011"

typestring

Internet Exchange Service Type

Default:"IX"

Value:"IX"

Example:"IX"

namestring

Name

Example:"ix_exchange_service"

bandwidthinteger

bandwidth in Mbps

Example:400000

descriptionstring

Description

Example:"ix_exchange_service"

statestring

State

Enum:"PROVISIONING""PROVISIONING_FAILED""PENDING_ACTIVATION""ACTIVATING""ACTIVATING_FAILED""PROVISIONED""REPROVISIONING""REPROVISIONING_FAILED""DEPROVISIONING""DEPROVISIONED"

Example:"PROVISIONING"

locationobject(SimplifiedLocation)

publicPeeringConnectionobject(PublicPeeringConnectionResponse)

routingProtocolobject(RoutingProtocolResponse)

orderobject(ExchangeServiceOrder)

Ordering and billing reference details for this Exchange Service.

projectobject(Project)

accountobject(SimplifiedAccount)

notificationsArray of objects(ExchangeServiceNotification)

Preferences for notifications on Internet Exchange Service configuration or status changes

changelogobject(PlatformChangelog)

Change log

additionalInfoobject(ExchangeServiceAdditionalInfo)

Additional information regarding the specified Exchange Service

Response

{
  "href": "https://api.equinix.com/fabric/v4/exchangeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011",
  "uuid": "a8ba52de-faae-43b5-b0b1-6904d37ee011",
  "type": "IX",
  "name": "ix_exchange_service",
  "bandwidth": 400000,
  "description": "ix_exchange_service",
  "state": "PROVISIONING",
  "location": {
    "metroHref": "https://api.equinix.com/fabric/v4/metros/SV",
    "metroCode": "SV"
  },
  "publicPeeringConnection": {
    "type": "IX_VC",
    "href": "https://api.equinix.com/fabric/v4/connections/b44c6e6c-2c36-4488-b3f1-47064357b5b4",
    "uuid": "b44c6e6c-2c36-4488-b3f1-47064357b5b4"
  },
  "routingProtocol": {
    "customerAsn": 5555,
    "macAddress": "00:11:22:33:44:55",
    "vlan": 99,
    "routeServerAsn": 24115,
    "bgpIpv4": { … },
    "bgpIpv6": { … },
    "routeCollector": { … }
  },
  "order": {
    "purchaseOrderNumber": "1-3456576",
    "orderNumber": "1-139105284200"
  },
  "project": {
    "projectId": "e275485c-7072-439f-943a-c923548b2be5"
  },
  "account": {
    "accountNumber": 100179
  },
  "notifications": [
    { … }
  ],
  "changelog": {
    "createdBy": "12345",
    "createdDateTime": "2025-08-30T07:21:39Z"
  },
  "additionalInfo": {
    "errorCode": "EQ-3058039",
    "errorMessage": "Unable to activate Exchange Service Port. Please verify your configuration or contact support."
  }
}